Welcome to cfme_tests’s documentation!

Contents:

Getting Started

Before you start

Welcome to the Getting Started Guide. The CFME QE team is glad that you have decided to read this page that will help you understand how cfme_tests interacts with the appliances. There are some important information contained within this text, so we would like you to spend some time to carefully read this page from beginning to the end. That will make you familiarize with the process and will minimize the chance of doing it wrong. Then you can proceed the shortest way using the setup and execution scripts.

Obtaining what you need (Project Setup)

  • create a dedicated folder for working with the integration tests, our automated quickstart has expectations that best work out when it has its own place
  • obtain the cfme_tests repository (fork and clone)
  • if you have access, obtain the cfme-qe-yamls repository (internal url, please ask the team) and put the .yaml_key file into the root of the cfme_tests repository.
  • enter the cfme_tests repository with your shell and execute python -m cfme.scripting.quickstart which will in turn configure your system, the development environment and the default configuration files
  • activate the development environment by . ../cfme_venv/bin/activate
  • Set up a local selenium server that opens browser windows somewhere other than your desktop. There is a Docker based solution for the browser, look at the script scripts/dockerbot/sel_container.py. That ensures you have the proper versions of browsers. You can also set everything up in your system using Xvnc - Selenium over VNC .

Appliances in containers

If the target appliance you will be testing is a container, you might like to consult Appliances in containers for the details specific to testing containers.

Running Tests

  • Test! Run miq-runtest. (This takes a long time, Ctrl-C will stop it)
  • When miq-runtest ends or you Ctrl-C it, it will look stuck in the phase “collecting artifacts”. You can either wait about 30 seconds, or you can Ctrl-C it again.
  • In either case, check your processes sometimes, the artifactor process likes to hang when forced to quit, but it can also happen when it ends normally, though it is not too common.

Testing Framework

The testing framework being used is py.test

Execution script

An execution script (cfme_test.sh) is provided. This script handles orchestration of docker, virtualenv, and cfme_test.

Configure path to your virtualenv and your cfme_test repository in the cfme_tests/conf/env.local.yaml.

tmux:
    PYTHON_ENV_PATH: 'path/to/virtualenv/bin'
    CFME_TEST_PATH: 'path/to/cfme_tests_repo'

The script requires shyaml (pip install shyaml) and tmux (yum install tmux) commands.

#Bash example:
cd /path/to/cfme_test
./cfme_test.sh

Navigating within the console:

  • Command mode: ctrl+shift+b
    • up/down to change pane
    • ‘[‘ to scroll within a pane
      • press the ‘Esc’ key to exit scrolling

More tmux commands can be found here: https://tmuxcheatsheet.com/

Using the testing framework (for newbies or non-CFMEQE core people)

Our team relies on a lot of internal tools that simplify life to the QEs. If eg. a developer would like to run cfme_tests on his/her system, here are some tools and tips that should get you started as quickly as possible:

  • cfme_tests expects an appliance, with an IP visible to the machine that runs cfme_tests

    • If this is not the case (eg. CFME behind NAT, a container, whatever), you MUST specify the base_url in configuration with a port, which is quite obvious, but people tend to forget cfme_tests also uses SSH and Postgres extensively, therefore you MUST have those services accessible and ideally on the expected ports. If you don’t have them running on the expected ports, you MUST specify them manually using --port-ssh and --port-db command-line parameters. If you run your code outside of miq-runtest run, you MUST use utils.ports to override the ports (that is what the command-line parameters do anyway). The approach using utils.ports will be most likely discontinued in the future in favour of merging that functionality inside utils.appliance.IPAppliance class. Everything in the repository touching this functionality will get converted with the merging of the functionality when that happens.

  • cfme_tests also expects that the appliance it is running against is configured. Without it it won’t work at all! By configured, we mean the database is set up and seeded (therefore UI running), database permissions loosened so cfme_tests can access it and a couple of other fixes. Check out utils.appliance.IPAppliance.configure(), and subsequent method calls. The most common error is that a person tries to execute cfme_tests code against an appliance that does not have the DB permissions loosened. The second place is SSH unavailable, meaning that the appliance is NAT-ed

    • Framework contains code that can be used to configure the appliance exactly as cfme_tests desires. There are two ways of using it:

  • Previous bullet mentioned the scripts/ipappliance.py script. This script can call any method or read any property located in the utils.appliance.IPAppliance. Check the script’s header for more info. The call to that method is threaded per-appliance, so it saves time. Despite the parallelization, the stdout (one line per appliance - return value of the method) prints in the same order as the appliances were specified on the command line, so it is suitable for further shell processing if needed.

  • Similarly, you can use scripts/appliance.py script for interacting with the utils.appliance.Appliance methods. It is a bit older and has slightly different usage. And lacks threading.

  • Using utils.appliance.Appliance only makes sense for appliances on providers that are specified in cfme_data.yaml.

  • If you want to test a single appliance, set the base_url in the conf/env.yaml

  • If you want to test against multiple appliances, use the --appliance w.x.y.z parameter. Eg. if you have appliances 1.2.3.4 and 2.3.4.5, then append --appliance 1.2.3.4 --appliance 2.3.4.5 to the miq-runtest command. Due to a glitch that has not been resolved yet, you should set the base_url to the first appliance.

  • If you have access to Sprout, you can request a fresh appliance to run your tests, you can use command like this one:

    SPROUT_USER=username SPROUT_PASSWORD=verysecret miq-runtest <your pytest params> --use-sprout --sprout-group "<stream name>" --sprout-appliances N

    If you specify N greater than 1, the parallelized run is set up automatically. More help about the sprout parameters are in fixtures.parallelizer. If you don’t know what the sprout group is, check the dropdown Select stream in Sprout itself.

Browser Support

We support any browser that selenium supports, but tend to run Firefox or Chrome.

For detailed instructions on setting up different browsers, see Browser Configuration.

Guides

Abbreviations and Naming Conventions

Abbreviations

In order to save line space and aid in quick pass reading, we have defined some abbreviations which we propose to be used throughout the code base.

Common Terms
Abbreviation Meaning
cfg, config Configuration
prov Provider
pg Page
db Database
img Image
vm Virtual Machine
creds Credentials
Locator Terms
Abbreviation Meaning
btn button
sel select
txt text
pwd password
chk checkbox
tarea textarea

Browser Configuration

All browser configuration is done by editing conf/env.yaml, or creating a local override in conf/env.local.yaml. Local overrides are preferred. For more information about configuration yamls, see utils.conf.

All yaml examples in this document are snippets from env.yaml.

Local vs. Remote

Most WebDrivers can operate in two modes, as a local WebDriver or through a Remote WebDriver. The local WebDriver will launch a browser in the calling environment (such as your desktop), while the Remote WebDriver will connect to a remote selenium server (hence the name) and attempt to run the browser there.

Examples for each mode will be provided, where appropriate. Note that capitalization is extremely important when specifying either webdriver or browserName, as indicated in the examples below.

Some help for setting up the remote selenium server can be found in the Selenium over VNC document.

Standalone Selenium Server

A Selenium Server is needed in order to run Remote Selenium WebDriver. You can install and run the Standalone Selenium Server which is a very common method. Although you may run this locally, it is still setup as a Remote webdriver as described above.

For more information, view the Selenium over VNC document.

WebDriver Wharf

A variant of the Remote webdriver, WebDriver Wharf will spawn docker containers running the selenium standalone server on request.

Remote desired_capabilities

All Remote drivers take a “desired_capabilities” dictionary. Details on what keys and expected value types can be used in this dictionary can be found in the selenium documentation:

Selenium, by default, looks for the selenium server on localhost port 4444. If the selenium server is running on a different machine, you’ll need to add a command_executor option to webdriver_options in the examples below to the machine running the selenium server.

command_exector must be a URL to a selenium server hub, which by default is at the /wd/hub path on the selenium server.

For example:

browser:
     webdriver: Remote
     webdriver_options:
         command_executor: http://selenium-server-hostname:port/wd/hub
         desired_capabilities:
             browserName: browser

Note

  • Each browser has its own set of capabilities, and those capabilities will usually not apply from one browser to another.
  • While most selenium identifiers have been translated from JavaIdentifiers to python_identifiers, the keys of desired_capabilities are not altered in any way. No name translation should have to be done for desired_capabilities keys (e.g. browserName does not become browser_name).

base_url

Regardless of which Webdriver you use, base_url must be set. It is assumed that the website at the base_url will be a working CFME UI.

Note

base_url is not solely used by the browser. Other functionality, such as the SSH and SOAP clients, derive their destination addresses from the base_url.

Firefox

Firefox has built-in support for selenium (and vice-versa). No additional configuration should be required to use the Firefox browser.

Local
browser:
    webdriver: Firefox
Remote
browser:
    webdriver: Remote
    webdriver_options:
        desired_capabilities:
            browserName: firefox
WebDriver Wharf
browser:
    webdriver: Remote
    webdriver_options:
        desired_capabilities:
            browserName: firefox
    webdriver_wharf: http://wharf.host:4899/

Chrome

In order to use Chrome with selenium, you must first install the chromedriver executable. This executable should be somewhere on your PATH.

Local
browser:
    webdriver: Chrome
Remote
browser:
   webdriver: Remote
   webdriver_options:
       desired_capabilities:
           browserName: chrome
WebDriver Wharf
browser:
    webdriver: Remote
    webdriver_options:
        desired_capabilities:
            browserName: chrome
    webdriver_wharf: http://wharf.host:4899/

Safari

Like Firefox, Safari is natively supported by selenium. Usage is equally simple, with the exception that you’ll probably need to be running selenium on OS X.

Local
browser:
    webdriver: Safari
Remote
browser:
    webdriver: Remote
    webdriver_options:
        # If selenium is running remotely, remember to update command_executor
        #command_executor: http://safari_host/wd/hub
        desired_capabilities:
            browserName: safari

Internet Explorer

Like Chrome & chromedriver, Internet Explorer needs a separate executable to work with selenium, InternetExplorerDriver. InternetExplorerDriver is a server that only runs in Windows, and should be running before starting selenium in either Local or Remote mode.

Local
browser:
    webdriver: Ie
Remote
browser:
    webdriver: Remote
    webdriver_options:
        # If selenium is running remotely, remember to update command_executor
        #command_executor: http://windows_host/wd/hub
        desired_capabilities:
            browserName: internet explorer
            # platform must be WINDOWS for IE
            platform: WINDOWS

Sauce Labs

By providing selenium servers on a multitude of platforms, Sauce Labs is able to help us test in “exotic” environments. In order to test against appliances behind firewalls, sauce-connect must be used:

sauce-connect tunnels are used by default if they’re running, so the same command_executor can be used to use the sauce labs service whether sauce-connect is running or not:

command_executor: http://username:apikey@ondemand.saucelabs.com:80/wd/hub
Internet Explorer Sauce

The following example is our “worst-case scenario”, which is running a very recent release of Internet Explorer in a very recent release of Windows:

browser:
    webdriver: Remote
    webdriver_options:
        command_executor: http://username:apikey@ondemand.saucelabs.com:80/wd/hub
        desired_capabilities:
            browserName: internet explorer
            platform: Windows 8.1
            version: 11
            screen-resolution: 1280x1024

The above configuration, at the time of this writing, ran our test suite with no issues.

More information on sauce-specific options allowed in desired_capabilities can be found in the sauce labs documentation:

Note

Python values for the browser constants used in the sauce labs “platform” page can be found here: https://code.google.com/p/selenium/source/browse/py/selenium/webdriver/common/desired_capabilities.py

Troubleshooting

If errors are encountered while launching a selenium browser, check the selenium website to make sure that your version of selenium matches the latest version. If not, upgrade.

Appliances in containers

This original testing suite was designed around appliances so testing of the docker container of ManageIQ is naturally trying to mimic the original environment as much as possible in order to keep the differences minimal. So for testing the container there are a couple of prerequisities:

  • A VM with docker (Preferably Fedora, RHEL/Centos, ...)
  • Docker image pulled into the VM
  • A script called cfme-start which will ensure these things:
    • Runs the docker container with CFME (with the right version)
    • Maps ports 80, 443, 5432 directly to the VM’s ports so HTTP(S) and PostgreSQL are publicly accessible
    • Maps the /share folder in the VM as /share folder in the container.

The script must be accessible as a general command, so it should preferably live eg. in /usr/local/bin/ and be chmod +x.

You then just templatize the VM and you can reuse it. There is a Sprout support coming.

Finally, you have to put container in the env.yaml so it looks something like this:

base_url: https://1.2.3.4/
container: cfme
whatever: else_is_required

The container key’s values is the name of the container deployed by cfme-start.

When you are done with all these steps, you are good to go with running the tests against it! And do not forget that because of lack of the SSH daemon in the container, you are not able to use the SCP directly like the utils.ssh.SSHTail does, but only through the wrapper methods utils.ssh.SSHClient.put_file() and utils.ssh.SSHClient.get_file(). It would work, but it would only get you to the host VM, not into the container. The aforementioned wrapper methods work by copying the file through shared directory.

Style Guide

General Guidelines

Contributing
  • Own your pull requests; you are their advocate.
    • If a request goes unreviewed for two or three days, ping a reviewer to see what’s holding things up.
    • Follow up on open pull requests and respond to any comments or questions a reviewer might have.
  • Keep the contents of the pull request focused on one idea. Smaller pull requests are easier to review, and thus will be merged in more quickly.
  • After submitting a request, be ready to work closely with a reviewer to get it tested and integrated into the overall test suite.
  • Follow the Code Style guidelines to make your pull request as easy to review as possible.
  • If your request requires the use of private information that can’t be represented in the data file templates (probably cfme_data.yaml), please state that in the test module docstring or the individual test docstring, along with information on where that data can be found.
  • Similar to the last point, any data files used by a test module should be clearly documented in that module’s docstring.
  • Any data required in a sensitive data file should be reflected in the template for that file.
  • Standards may change over time, so copying older code with similar functionality may not be the most productive action. If in doubt, refer back to this document and update the copied code according to the current guidelines.
  • Please keep large lint changes separate from new features, though this point should become less relevant over time.
  • All pull requests should be squashed down to logical blocks of distinctive functionality that work by themselves and do not result in brokenness of master
    • As an example, if you were working on a test which required new pages, utilities and tests, it would be OK to split the page, utility and test changes into separate requests or commits, providing they were in the correct order of dependency.
Reviewers

Reviewers will be looking to make sure that the Contributing guidelines are being met. Some of the things that go into the review process:

  • Assign the PR to the reviewer
  • Pull request branches will be rebased against current master before testing.
  • Newly added tests will be run against a clean appliance.
  • Adherence to code style guidelines will be checked.

If tests fail, reviewers WILL:

  • ...give you a complete traceback of the error.
  • ...give you useful information about the appliance against which tests were run, such as the appliance version.
  • ...give you insight into any related data files used.

If tests fail, reviewers WILL NOT:

  • ...thoroughly debug the failing test(s).

All requests require 2 approvals from two reviewers, after which time, the contributor may, permissions allowing, merge the commit him/herself.

Reviewers must never approve their own pull requests.

Code Style

We adhere to Python’s PEP 8 style guide , occasionally allowing exceptions for the sake of readability. This is covered in the Foolish Consistency section of PEP 8. Information on using linting tools to help with this can be found on the flake8 page.

We also do a few things that aren’t explicitly called out in PEP 8:

  • The github pull request pane is our primary code review medium, and has a minimum width of 100 characters. As a result, our maximum line length is 100 characters, rather than 80.

  • Use parentheses () for line continuation:

    # in imports
import (module1, module2, module3, module4,
    module5)

    or

import (
    module1, module2, module3,
    module4)

    or

import (
    module1,
    module2,
    module3
)

# in long strings without multiple lines
very_long_string = (
    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt "
    "ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation "
    "ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in "
    "reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur "
    "sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id "
    "est laborum."
)

  • Docstrings can be used in strings with multiple lines:

    string_with_multiple_lines = """Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation"""

  • When wrapping blocks of long lines, indent the trailing lines once, instead of indenting to the opening bracket. This helps when there are large blocks of long lines, to preserve some readability:

    _really_really_long_locator_name = (True, ('div > tr > td > a[title="this '
    'is just a little too long"]'))
_another_really_super_long_locator_name = (True, ('div > tr > td > '
    'a[title="this is getting silly now"]'))

  • When wrapping long conditionals, indent trailing lines twice, just like with function names and any other block statement (they usually end with colons):

    if (this_extremely_long_variable_name_takes_up_the_whole_line and
        you_need_to_wrap_your_conditional_to_the_next_line):
    # Two indents help clearly separate the wrapped conditional
    # from the following code.

  • When indenting a wrapping sequence, one indent will do. Don’t try to align all of the sequence items at an arbitrary column:

    a_good_list = [
    'item1',
    'item2',
    'item3'
]

a_less_good_list = [ 'item1',
                     'item2',
                     'item3'
]

  • According to PEP 8, triple-quoted docstrings use double quotes. To help differentiate docstrings from normal multi-line strings, consider using single-quotes in the latter case:

    """This is a docstring.

It follows PEP 8's docstring guidelines.

"""

paragraph = '''This is a triple-quoted string, with newlines captured.
PEP 8 and PEP 257 guidelines don't apply to this. Using single quotes here
makes it simple for a reviewer to know that docstring style doesn't apply
to this text block.'''

  • On the subject of docstrings (as well as comments) +++use them+++. Python is somewhat self-documenting, so use docstrings and comments as a way to explain not just what code is doing, but why it’s doing what it is, and what it’s intended to achieve.

    We have decided to use the following docstring format and use the Cartouche Sphinx plugin to generate nice docs. Details on the format can be found above, but an example is described below:

    def my_function(self, locator):
    """Runs the super cool function on a locator

    Seriously, you have to try this

    Note: You don't actually have to try it

    Args:
        locator: The name of a locator that can be described by using
            multiple lines.

    Returns:
        Nothing at all.

    Raises:
        CertainQuestionsError: Raises certain questions about the authors sanity.
    """

  • In addition to being broken up into the three sections of standard library, third-party, and the local application, imports should be sorted alphabetically. ‘import’ lines within those sections still come before ‘from ... import’ lines:

    import sys
from os import environ
from random import choice

  • We require print statements be written in Python 3.0 compatible format, that is encased in parentheses:

    print("Hello")

  • We also use the newer .format style for string formatting and will no longer be accepting the older %s format. The new format offers many more enhancements:

    a = "new"
b = 2

"a {} string for {}".format(a, b)

"{name} is {emotion}".format(name="john", emotion="happy")

"{0} and another {0}".format("something")

  • There is a one exception for string formatting. According https://docs.python.org/3/howto/logging.html#optimization use old style %s, but without the actual % formatting operation:

    from utils.log import logger

logger.info("Some message %s", some_string)
General Notes
  • Avoid using time.sleep() as much as possible to workaround quirks in the UI. There is a utils.wait.wait_for() utility that can be used to wait for arbitrary conditions. In most cases there is some DOM visible change on the page which can be waited for.
  • Avoid using time.sleep() for waiting for changes to happen outside of the UI. Consider using tools like mgmt_system to probe the external systems for conditions for example and tie it in with a utils.wait.wait_for() as discussed above.
  • If you feel icky about something you’ve written but don’t know how to make it better, ask someone. It’s better to have it fixed before submitting it as a pull request ;)
  • Use six library to write Python 3 compatible code.

Other useful code style guidelines:

cfme_tests

For page development, please refer to Page Development.

Layout

cfme_tests/

  • cfme/ Page modeling and tests
    • web_ui/ The new web framework
    • fixtures/ The new fixtures
    • tests/ Tests container
  • conf/ Place for configuration files
  • data/ Test data. The structure of this directory should match the structure under cfme/tests/, with data files for tests in the same relative location as the test itself.
    • For example, data files for cfme/tests/dashboard/test_widgets.py could go into data/dashboard/test_widgets/.
  • fixtures/ py.test fixtures that can be used by any test. Modules in this directory will be auto loaded.
  • markers/ py.test markers that can be used by any test. Modules in this directory will be auto loaded.
  • cfme/metaplugins/ Plugins loaded by @pytest.mark.meta. Further informations in markers.meta
  • utils/ Utility functions that can be called inside our outside the test context. Generally, util functions benefit from having a related test fixture that exposes the utility to the tests. Modules in this directory will be auto loaded.
    • tests/ Unit tests for utils
  • scripts/ Useful scripts for QE developers that aren’t used during a test run
  • sprout/ Here lives the Sprout appliance tool.
Writing Tests

Tests in cfme_tests have the following properties:

  • They pass on a freshly deployed appliance with no configuration beyond the defaults (i.e. tests do their own setup and teardown).
  • Where possible, they strive to be idempotent to facilitate repeated testing and debugging of failing tests. (Repeatable is Reportable)
  • Where possible, they try to clean up behind themselves. This not only helps with idempotency, but testing all of the CRUD interactions helps to make a thorough test.
  • Tests should be thoroughly distrustful of the appliance, and measure an action’s success in as many ways as possible. A practical example:
    • Do not trust flash messages, as they sometimes tell lies (or at least appear to). If you can go beyond a flash message to verify a test action, do so.

Some points when writing tests:

  • When naming a test, do not use a common part of multiple test names as a test name itself. In the example below, trying to run a single test called test_provider_add, not only runs that test, but also test_provider_add_new and test_provider_add_delete, as pytest uses string matching for test names. test_provider_add should have a suffix making it unique. In this way a tester can choose the run just the single test on its own, or the group of tests, whose names all begin the same way.
    • test_provider_add - Adds a provider (Bad naming)
    • test_provider_add_new - Adds a new provider type
    • test_provider_add_delete - Adds a provider and then deletes it
  • Where a clean-up is required, it should be carried out in a Finalizer. In this way we prevent leaving an appliance dirty if the test fails as the clean up will happen regardless.
  • Keep all properties, fixtures and functions together
Fixtures

Fixtures are not only responsible for setting up tests, but also cleaning up after a test run, whether that test run succeeded or failed. addfinalizer is very powerful. finalizer functions are called even if tests fail.

When writing fixtures, consider how useful they might be for the overall project, and place them accordingly. Putting fixtures into a test module is rarely the best solution. Instead, try to put them in the nearest conftest.py. If they’re generic/useful enough consider putting them into one of the fixtures/ directory for use in cfme_tests or the plugin/ directory for use in both projects.

This Document

This page is subject to change as our needs and policies evolve. Suggestions are always welcome.

Documenting cfme_tests

Overview

In addition to PEP 257, inline documentation of the cfme_tests code adheres to the Google Python Style Guide. The Google-recommended docstring format is very easy to both read and write, and thanks to the cartouche library, it’s parseable by sphinx, which we use to generate our documentation.

The documentation is built and hosted by the excellent readthedocs service, but should be built locally before making a pull request.

docstrings

The napoleon library parses our docstrings and turns them into nicely rendered API docs in the sphinx output. As such, we should follow napoleon’s usage guidelines when writing docstrings:

According to PEP 257, docstrings should use triple double-quotes, not triple single-quotes (“”” vs. ‘’‘).

Example:

"""This is a docstring."""

'''This is not a docstring.'''

Documenting Tests

Tests are documented slightly differently to modules, in that they require certain extra information that isn’t required for a module/class/function. If a test uses the testgen library it must also specify a test_flag in the metadata section. An example of this is shown below.

"""Tests provisioning via PXE

Metadata:
    test_flag: pxe, provision
"""

These flags are also defined in the cfme_data.yaml file, under the test_flags: key. A provider in the cfme_data.yaml can opt out of collection for a particular test_flag by including the flag in the list of excluded_test_flags: key in the providers stanza. All of the flags listings are listed in comma separated format. This was chosen to cut down on syntax characters and all values are whitespace stripped.

For a test to be collected for a provider:
  • the test_flag must be listed in the cfme_data.yaml file test_flags: key
  • the test_flag must be listed in the metadata section of the test’s docstring
  • the test_flag must NOT appear in the list of excluded_test_flags: for a particular provider

It is beneficial that the documented test also has its description in it in Google-style format. When the automated tests get imported in our test case management system, the comment is imported as a description, so you don’t have to write it twice!

"""Tests provisioning via PXE

This test verifies that foo causes bar to crash.

Prerequisities:
    * bar is set up
    * baz

Steps:
    1) Ook.
    2) Ook?
    3) Ook!

Metadata:
    test_flag: pxe, provision
"""

Linking new modules

As new modules are created, they’ll need to be added to the documentation tree. This starts in the toctree directive in docs/index.rst. Each entry in that tree references other .rst files in the docs/ directory, which can in turn reference documentation sources in their own toctree directives (ad infinitum).

Once the rst file has been inserted into the toctree (assuming one had to be created), sphinx needs to be told to generate documentation from the new code. We use sphinx’s autodoc feature to do this, and it looks like this:

.. automodule:: packagename.modulename

The paramater passed to the automodule should be the importable name of the module to be documented, cfme.login for example.

There is no hard and fast rule for where things should go in the toctree, but do try to keep the docs well-organized.

Building the Docs

Prior to pushing up new code, preview any new documentation by building to docs locally. You can do this using the sphinx-build command. From the cfme_tests directory:

sphinx-build -b html docs/ docs/build/

This will build html documentation based on the sources in the docs/ directory, and put them in the docs/build/ directory, which can then be opened in a browser:

google-chrome docs/build/index.html
# or...
firefox docs/build/index.html

Setting up editors

Sublime

The “supported” editor of choice for working on this project is Sublime Text 2 (sublime), though these instructions will likely also work for Sublime Text 3. Of course you’re free to use whichever editor helps you be the most productive, but the preponderance of Sublime users on the team make it the most useful target for our development environment setup documentation.

Getting Started
Get sublime

To begin, sublime must be installed. It is distributed via a tarball from the sublime download page. This tarball can be extracted anywhere. A likely place is in your home folder. Once extracted, run the sublime_text executable in the new directory to start the editor.

Configure sublime for Python

By default, sublime will attempt to autodetect indentation. When this autodetection fails, it will fall back to using 4-space tab stops, but using tabs instead of spaces. To easily address this, open any .py in the editor, and then select Preferences > Settings - More > Syntax Specific - User from the menu. This should open up Python.sublime-settings. In this file, enter the following options and save:

{
    "detect_indentation": false,
    "rulers": [100],
    "tab_size": 4,
    "translate_tabs_to_spaces": true,
    "use_tab_stops": true
}

This will force python files to match our code style guidelines, which use spaces instead of tabs with an indentation of 4 spaces.

The rulers option will also draw a vertical line at 100 characters as a visual aid to keep lines from getting too long. Additional integer values can be added to the rulers list; it might be useful to also have a rule at 80 columns as a “soft limit”, for example.

Package Control

Once sublime is up and running, we’ll need to install some package management, which we’ll be using hereafter to bring in sublime extensions. Follow the installation instructions here. Be sure to follow the instructions for Sublime Text 2, unless you’re beta testing Sublime Text 3.

Note

When installing packages, it is sometimes necessary to restart sublime for the installed packages to initialize. For simplicity, it is probably easiest to restart sublime after installing any package. Restarting sublime after changing configuration files should not be necessary.

SublimeCodeIntel

Install the SublimeCodeIntel package. Select Preferences > Package Control from the program menu, then choose “Install Package”. Enter “SublimeCodeIntel”. Once installed, SublimeCodeIntel will provide autocompletion for imports and function/method calls.

SublimeCodeIntel will autodetect python names from project directories (visible in the sidebar) for autocompletion, but it won’t detect builtins or installed libraries. To enable this, SublimeCodeIntel needs to be given a hint. It looks for config files in .codeintel directories inside of project directories, so we’ll be putting the hint there. The cfme_tests directory is the perfect place for the .codeintel directory, so ensure that the cfme_tests directory has been added to your current project. If not, Project > Add Folder to Project..., and select your cfme_tests directory.

Using your tool of choice (for example, a shell or sublime itself), make the .codeintel directory under cfme_tests. Inside that directory, create and edit the file config (cfme_tests/.codeintel/config). Like most sublime configuration files, the content of this file is a python dictionary. It looks very similar to JSON, which is used in most sublime configuration files, so be mindful of the different syntax.

Insert the following:

{
    "Python":
    {
        "codeintel_scan_files_in_project": True,
        "python": "/path/to/virtualenv/bin/python",
        "pythonExtraPaths":
        [
            "/path/to/virtualenv/lib/python2.7/site-packages"
        ]
    }
}

Remember to change the /path/to/virtualenv strings to be the actual path to your virtualenv. python should point to the virtualenv’s python interpreter.

Relative paths can be used here, and will be relative to the project folder (in this case, cfme_tests), not the location of this config file. So, if cfme_tests is in the same directory as the virtualenv’s bin and lib directory, The paths for python and pythonExtraPaths could start with ../bin and ../lib, respectively.

Flake8 Lint

Using Package Control, install the “Python Flake8 Lint” package. To apply our specific style exceptions to this package, edit the configuration. Via the menu, choose Preferences > Package Settings > Python Flake8 Lint > Settings - User. In the settings file that opens, enter our exceptions:

{
      "pep8_max_line_length": 100,
      "ignore": ["E128"]
}

Flake8 lint will pop up every time you save a file, and does an excellent job of keeping you linted while you code.

Trailing Spaces

Using Package Control, install the “Trailing Spaces” plugin. This highlights trailing spaces so you can clean them up before flake8 sees them.

Sublime Text 3

Sublime Text 3 is currently in beta, but it is perfectly usable for python development. I will show you my setup here (mfalesni). Prerequisities are the same as for ST2 (Package Control).

emacs

So far the best emacs setup I’ve (jweiss) found is iPython notebook, combined with the ein emacs package (emacs iPython notebook).

Installing iPython and its Emacs client
iPython

See the install docs.

ein

Emacs iPython Notebook is the emacs client for iPython.

The official ein package does not work with the latest ipython. I built a package from the fork of ein that does work. You can get the package from the internal repository listed below. You should also add the Melpa repository.

(add-to-list 'package-archives
  '("melpa" . "http://melpa.milkbox.net/packages/") t)
(add-to-list 'package-archives
  '("jweiss" . "http://qeblade5.rhq.lab.eng.bos/isos/emacs-package-archive/") t)

You can then run M-x package-install, ein in emacs to install ein.

Then in a shell somewhere, you can start up iPython notebook process. This is the python process that will intepret all the code you will be sending it.

$ source ~/my-virtual-env/bin/activate
$ cd ~/my-project
$ ipython notebook

Then in emacs, run M-x ein:notebooklist-open. It will prompt you for a port (default 8888). This will bring up the EIN environment, where you can evaluate python snippets (and edit them and evaluate them again). You can also save the notebook to use your snippets again later. The outputs are also saved.

Starting iPython from within Emacs

I wrote a little bit of elisp to start a iPython notebook process for you from within emacs. It’s easier than having to type shell commands every time. It requires the magit package, which I highly recommend (it is a git client for emacs).

(autoload 'magit-get-top-dir "magit" nil t)

(defun magit-project-dir ()
  (magit-get-top-dir (file-name-directory (or (buffer-file-name) default-directory))))

(defun start-ipython-current-project (virtualenv-dir)
  (interactive
   (let ((d (read-directory-name "VirtualEnv dir: " "~/.virtualenvs/" nil t)))
     (list d)))
  (save-excursion
    (let ((buf (get-buffer-create
                (generate-new-buffer-name (file-name-nondirectory
                                           (directory-file-name (file-name-directory (magit-project-dir))))))))
      (shell buf)
      (process-send-string buf (format ". %s/bin/activate\n" virtualenv-dir))
      (process-send-string buf (format "cd %s;ipython notebook\n" (magit-project-dir))))))

To use the above snippet,

  • Go to any buffer that’s visiting any file in your project (or any buffer whose pwd is in your project)
  • M-x start-ipython-current-project
  • At the prompt, input the directory where your virtualenv lives

It will start ipython in emacs’ shell buffer.

Autosave Notebooks

Unlike the iPython web interface, ein does not autosave notebooks by default. Here is a snippet that will enable autosave (notebooks are saved every time you execute a cell)

;; ein save worksheet after running cell
(eval-after-load 'ein-multilang
  '(defadvice ein:cell-execute (after ein:save-worksheet-after-execute activate)
     (ein:notebook-save-notebook-command)))
Flake8 Lint

Flycheck is recommended because it highlights the column where the problem occurs instead of just the line.

Run M-x package-install, flycheck, and see the Flycheck homepage.

You can use the global mode as described on the homepage, or to just enable flymake for python files

(autoload 'flycheck "flycheck-mode")
(eval-after-load 'python
  '(add-hook 'python-mode-hook 'flycheck-mode))

Gotchas

Selenium has a few quirks which have caused us immense amounts of debugging time. If you are facing strange issues with Selenium that you can’t explain and this usually boils down to “Selenium is lying to me”, please check this page first before spending vast amounts of time debugging .

Selenium is not clicking on the element it says it is

Sometimes, under certain circumstances, Selenium doesn’t click on the element you tell it to. The symptoms of this include having a WebElement that gives a certain value when queried with .text() and then Selenium actually clicking on the wrong element. This has been observed happening when there is a frame or some other element where horizontal scrolling has been introduced. A typical example would be in the left hand tree items in the System Image Type under the Infrastructure > PXE menu. If one system image name is 256 characters, this causes the problem to manifest.

Selenium is not sending the keys I tell it to, or is filling the box with junk

This should not be happening now since framework is configured to be more intelligent than Selenium and it detects whether the element filled is a file input or not. Because Selenium can be running remotely, if you want to upload a file, Selenium first needs to upload the file to the remote executor and then it changes the string accordingly. This happens in default Selenium configuration, as the selenium.webdriver.remote.file_detector.LocalFileDetector is used by default for all keyboard input. Framework now sets it up so the selenium.webdriver.remote.file_detector.UselessFileDetector is used by default and if the element filled is an input with type file, then the file detector is actually used.

When getting the text of the element, Selenium returns an empty string

Stop using the .text property of the WebElement and use cfme.fixtures.pytest_selenium.text(), which solves this issue. The thing is, when an element is eg. obscured, Selenium can’t read it. So the text function first tries to scroll the page so the element is visible, and if that does not help, it uses a bit of JavaScript to pull the text out.

flake8

There are many handy tools that can be used to check your code against established python style. A tool called flake8 exists to combine these tools into one easy-to-use package. flake8 is used by reviewers on pull requests for style compliance, so it’s a good idea to run flake8 before submitting code for review.

Note

All new content in pull requests is expected to pass flake8 linting.

Manual Invocation

To use flake8 in our project, first install it: pip install flake8 or easy_install flake8.

Some flags are required to deal with our specific alterations to python style:

  • We allow lines up to 100 characters in length; add --max-line-length=100
  • We indent block statement line continuations twice, even in function defs; add --ignore=E128

Then, aim it at the python file (or files) being edited:

flake8 --max-line-length=100 --ignore=E128 path/to/python_module.py
flake8 --max-line-length=100 --ignore=E128 path/to/python/package/`

These settings can be stored as defaults in a config file. By default, flake8 looks in ~/.config/flake8. Here is an example file that adheres to our style guidelines:

[flake8]
ignore = E128
max-line-length = 100

IDE Integration

Sublime Text 2 & 3

The excellent Flake8 Lint for the sublime text editor will do automatic linting using the flake8 tool. To configure it to follow our guidelines, Add the following options to your Flake8Lint.sublime-settings file:

"pep8_max_line_length": 100
"ignore": ["E128"]
Emacs

See flymake-python-pyflakes.el.

If you have Melpa or Marmalade package repos already set up, you can install the package by M-x package-install, flymake-python-pyflakes.

To activate on all Python files, add this to your emacs configuration:

(autoload 'flymake-python-pyflakes-load "flymake-python-pyflakes" nil t)
(eval-after-load 'python
  '(add-hook 'python-mode-hook 'flymake-python-pyflakes-load))

To use flake8 and our particular rules:

  • M-x customize-group, flymake-python-pyflakes
  • Set Flymake Python Pyflakes Executable to flake8
  • Add to Flymake Python Pyflakes Extra Arguments: * --max-line-length=100 * --ignore=E128
Others

If your IDE isn’t listed here, feel free to add instructions above!

Page Development

Introduction

This file is intended to explain how pages should be developed and specify what functionality should exist in them. Refering to the image below, a page model should contain the following:

  • Locators to elements which appear only on that page or set of pages related to the object in question.
  • Menu items to graft onto the main menu for use inside the pages and operations.
  • Classes that are related to objects in the database which are acted upon with CRUD operations on that page or set of pages.
  • Methods which are used to CRUD operations, with an aim that any of these can use a different backend where possible.

Anything else should be added as part of a web_ui component, a fixture or a utility.

_images/framework.png

Pages are read-only python modeling of the CFME UI, allowing the functional tests of the UI to be ignorant of the underlying page structure. As such, UI elements (pages, regions, forms, etc.) modeled in cfme_pages must provide helper methods and properties to expose a usable interface to cfme_tests. This is explained in more detail in the section on Writing Tests in Style Guide.

Pages should be modeled as a part of writing tests. Code in cfme_pages must never depend on code in cfme_tests.

When writing pages, a few points should be noted:

  • Follow the standard naming convention for locators
    • Name of element, followed by type from the type list
  • Type list: button, select, text, textbox, radio, option
  • Ensure that your element is presented in an expected way. As an example, presenting a div containing and unordered list in one place and simply the unordered list in another, causes an unpredictable inconsistency as to how to handle the locator.
  • Try to avoid using localized text as part of a locator where possible

Example

Since the majority of development happens in tests and page models, we will deconstruct a page to see how it is composedW.e will now look at a specific example using the cloud/provider.py file. Note that there may be subtle differences between the file and this documentation as the content evolves. It is expected that this document will be updated with any significant changes.

Imports

To begin with we have the imports, we have added comments after each to specify their use:

from functools import partial                   # Standard library
from selenium.webdriver.common.by import By     # Convenience functions for locators, ID etc.
import cfme                                     # Core cfme module
import cfme.web_ui.menu                         # Standard menu for grafting additional menus onto
from cfme.web_ui import Region, Quadicon, Form  # Loads the Region, Quadicon and Form UI elements
import cfme.web_ui.flash as flash               # Flash message handler
import cfme.fixtures.pytest_selenium as sel     # The selenium zero-level functions
from utils import conf                       # Loads all configuration from the yamls
from utils.update import Updateable             # Updatable class to give update capabilities
import cfme.web_ui.toolbar as tb                # Toolbar UI element for clicking Center Toolbar
Locators

Now that we have the tools we need to begin crafting a page, we can start to define the locators. Locators are used to point to elements on a page. They can reference any html element and will typically be used:

  • to pull out text for comparision, e.g. making sure a flash message matches what is expected.
  • to send text to, e.g. for inputting data into forms.
  • to click, e.g. a button.

Below is an excerpt from the set of locators on the page:

page = Region(
    locators={
        'add_submit': "//img[@alt='Add this Cloud Provider']",
        'creds_validate_btn': "//div[@id='default_validate_buttons_on']"
                              "/ul[@id='form_buttons']/li/a/img",
        'creds_verify_disabled_btn': "//div[@id='default_validate_buttons_off']"
                                     "/ul[@id='form_buttons']/li/a/img",
        'cancel_button': "//img[@title='Cancel']",
        'save_button': "//img[@title='Save Changes']",
    },
    title='CloudForms Management Engine: Cloud Providers')

Locators are usually supplied as a Python dict. The key is a name which should conform to the Abbreviations and Naming Conventions guidelines. The value is one of three:

  • an XPATH string, as depicted above
  • a tuple, containing a CSS selector, e.g. (By.CSS_SELECTOR, "div.dhtmlxInfoBarLabel-2 > ul")
  • a tuple, containing an ID selector, e.g. (By.ID, "text_button")

These elements can then be used to perform actions as shown later in the file by:

if cancel:
    sel.click(page.cancel_button)
Forms

A recent edition to the codebase has been the introduction of Forms using the cfme.web_ui.Form web_ui component. Forms allow the defining of a set of locators which correspond to fields. Data can then be sent to the form object to fill in the fields automatically, without worrying about field type. We begin by defining a Form:

form = Form(
    fields=[
        ('type_select', "//*[@id='server_emstype']"),
        ('name_text', "//*[@id='name']"),
        ('hostname_text', "//*[@id='hostname']"),
        ('ipaddress_text', "//*[@id='ipaddress']"),
        ('amazon_region_select', "//*[@id='hostname']"),
        ('api_port', "//*[@id='port']"),
    ])

Notice that a Form is very similar to a Region. In fact, a Form inherits a Region so as above when we clicked on the cancel button by referencing it as an attribute of the page object. We can do the same here. sel.set_text(form.api_port, "6000"), for example, would set the text of the locator described by key value api_port to 6000.

The details to fill in the form are loaded into a variable inside the management object called OpenStackDetails in this case:

def __init__(self, hostname=None, ip_address=None, api_port=None):
    self.details = {'hostname_text': hostname,
                    'ipaddress_text': ip_address,
                    'api_port': api_port,
                    'type_select': 'OpenStack'}

These details are then passed to the Forms fill_fields function:

details.details.update({'name_text': self.name})
form.fill_fields(details.details)

Notice that there has been an amendment to the details dictionary when it has been passed into the _fill_details function, and a new key/value called name_text has been added.

The cfme.web_ui.Form.fill_fields() Form method then takes these values, does an inspection of the element types to find out how to handle them (you couldn’t set text on a select box for example), and then sets the values in the most appropriate way.

Toolbar

A Toolbar button can be accessed by simple using it in the following way:

tb.select('Configuration', 'Add a New Cloud Provider')

but in cases where we may have several Configuration buttons, we can make things a little simpler to type by making use of partial. Which takes a function and some arguments to create a shortened form of the function call. In the example below, we define this:

cfg_btn = partial(tb.select, 'Configuration')

We can now use the toolbars by doing something like the following:

cfg_btn('Add a New Cloud Provider')

Development Tips and Tricks

Introduction

This document is intended to explain some of the extra bits of the framework that are there to make your life easier. Not everything is included here and we encourage people to add new tricks as they are developed and rediscovered.

Version Picking

Dealing with multiple releases, it’s obvious that some things change from version to version. A lot of the time, these changes are simple, such as a string change. So that we can continue using the same codebase for any version, we define the idea of version picking. Version picking essentially returns an object depending on the version of an appliance. It’s particularly useful for things like locator changes because most of the element handling routines are version picking away. This means if they receive a dict as an argument, they will automatically try to resolve it using the version picking tool. To use version picking is easy:

from utils import version

version.pick({'5.4': "Houses",
              '5.3': "House",
              version.LOWEST: "Boat"})

In this example, if the version is below 5.3, the Boat will be returned. Anything between 5.3 and 5.4 will return House and anything over 5.4 will return Houses. There is also a version.LATEST which points to upstream appliances. Another important point to remember is that one shouldn’t verspick at import time. The best practise is to use it inside locators without using verpick excpliticly. The syntax is pretty simple:

locators={
    'properties_form': {
        version.LOWEST: Input('House'),
        '5.6': Input('Houses'),
             }
        }

Defining blockers

Sometimes we know a test fails due to a bug in the codebase. In order to make sure the test isn’t run and attributing an extra fail that doesn’t need to be investigated, we mark it with a meta marker. The meta marker is incredibly useful and integrates with our Bugzilla implementation to ensure that if a bug is still on DEV, or hasn’t even been assigned yet, that the test won’t run. The syntax is really easy:

@pytest.mark.meta(blockers=[12345, 12346])
def test_my_feature():
    # Test the new feature
    pass

Note the two bug numbers 12345 and 12346. More information can be found in the fixtures.blockers fixture.

Using blockers in tests

On the odd occasion, you don’t want to disable an entire test, but just a part of it, until a bug is fixed. To do this, we can specify a bug object and ask the framework to skip if a certain bug exists and is not closed. The syntax is pretty simple:

def my_test(provider, bug):
    ui_bug = bug(12234)
    if not ui_bug:
        # Do something unless the bug is still present in which case, it will be skipped

Uncollecting tests

There are times when conditions dictate that we don’t need to run a test if a certain condition is true. Imagine you don’t want to run a test if the appliance version is below a certain value. In these instances, you can use uncollectif which is a pytest marker:

@pytest.mark.uncollectif(lambda: version.current_version() < '5.3')
def test_my_feature():
    # Test the new feature
    pass

Now if the version of the appliance is less than 5.3. Then the test will not be skipped, it will never even try to be run. This is ONLY to be used when a certain test is not valid for a certain reason. it is NOT to be used if there is a bug in the code. See the Defining blockers section above for skipping because of a bug.

Running commands on another appliance

We implement a small appliance stack in the framework. When a test first starts it loads up the base_url appliance as the first appliance in the stack. From then on, all the browsing operations, database operations and ssh commands are run on the top appliance in the stack. From time to time it becomes necessary to run commands on another appliance. Let’s say you were trying to get two appliances to talk to each other, in this case, you would use the context manager for appliances.

By default, even if you add a new appliance onto the stack, the browser operations will keep happening on the last appliance that was used, however, there is a simple way to steal the browsers focus, and this is detailed in the example below:

appl1.ipapp.browser_steal = True
with appl1.ipapp:
    provider_crud.create()

In the example we have already created a new utils.appliance.Appliance object and called it appl1. Then we have set it to steal the browser focus. After this, we enter the context manager appl1.ipapp and are able to run operations like provider creates.

This is also why you should use ssh_client and db access from the store.current_appliance and not from the modules directly. If someone else uses your code and is inside an appliance context manager, the commands could be run against the wrong appliance.

Logging in as another user

In a similar way to the Running commands on another appliance section above, we implement a context manager for user operations. This allows the test developer to execute a section of code as a different user and then return to the original user once complete.

A major advantage of this, is that the User object used for the CM operations is the same as the cfme.configure.access_control object. This means that you can create a new user using the cfme.configure.access_control.User object and straight after use it as the context manager object:

cred = Credential(principal='uid', secret='redhat')
user = User(name='user' + fauxfactory.gen_alphanumeric(),
    credential=cred)
with user:
    navigate_to(current_appliance.server, 'Dashboard')

The User object stores the previous User object in a cache inside itself and on exiting the context, returns this to the pytest store as the current user so that future operations are performed with the original user.

Invalidating cached data

In order to speed things up, we cache certain items of data, such as the appliances version and configuration details. When these get changed, the cache becomes invalid and we must invalidate the cache somehow. It used to be handled with the utils.signals module which is now gone. You need to call an appropriate method on the appliance object like utils.appliance.IPAppliance.server_details_changed() which invalidates the data.

pytest store

The pytest store provides access to common pytest data structures and instances that may not be readily available elsewhere. It can be found in fixtures.pytest_store, and during a test run is exposed on the pytest module in the store namespace as pytest.store.

Test generation (testgen)

We try to consolidate common test generation functions in the utils.testgen module. When parametrizing tests with the pytest_generate_tests hook, check the testgen module to see if there are functions available that already parametrize on the axis you want (usually by provider, but there are some other helpers in there).

Working with file paths

For any path in the project root, there are several helper functions that can be used. Look at the utils.path module for the complete list of pre-configured directories and available functions.

Expecting Errors

When working with the UI, we can actually run a process and expect to have a certain flash error message. This is built into a context manager so that all you need to do is supply the operation you want to try, and the emssage you expect to get. This means as a test developer, you don’t need to worrk about how to get the flash message, or how to handle the resulting error from the operation failing:

provider.credentials['default'] = get_credentials_from_config('bad_credentials')
with error.expected('Login failed due to a bad username or password.'):
    provider.create(validate_credentials=True)

Appliance object SSH gremlins

If you get seemingly random SSH errors coming from utils.appliance, you might be facing the problem that some of the methods inside of the class does some version picking, or database connection outside of the object scope or whatever that is supposed to touch the target appliance but does not go through the object that you are in, but the utils.appliance.IPAppliance object itself is not pushed to the appliance stack in fixtures.pytest_store. So instead of using the IP address of the appliance the object is pointed to, it uses whatever was set before, either the base_url one or something that was pushed before. The solution is to wrap that in a with block, like this (presuming we call this code inside utils.appliance.Appliance):

with self.ipapp as ipapp:
    ipapp.wait_for_ssh()

    self._i_do_verpicking("and fail randomly when not in with block")

    success("!")

Until we come with a better solution, this will bite us from time to time when we forget about it.

Marking your tests with associated product requirements

Test requirements mapping

This module contains predefined pytest markers for CFME product requirements.

Please import the module instead of elements:

from cfme import test_requirements

pytestmark = [test_requirements.alert]

@test_requirments.quota
def test_quota_alert():
    pass

Selenium over VNC

Purpose

The goal of this page is to explain how to set up a remote display that can run selenium tests, and manage/contain test-related web browser windows.

Note

This document assumes that you’re running a recent Fedora release, and already have a working selenium setup for cfme_pages as explained in the cfme_pages README.

While these instructions are specific to tigervnc, available in Fedora 11 onward, they can be easily adapted to use other VNC packages.

Install requirements

We will need a VNC server (tigervnc-server), a lightweight window manager to run inside that VNC server (fluxbox), and a terminal emulator that can run inside the lightweight window manager (xterm):

# yum install tigervnc-server fluxbox xterm

We will also need the Standalone Selenium Server, which will run inside the VNC server. You can install and run it in any directory, but it is preferred to be installed in your virtualenv in a directory outside of or at the same level as your cfme_tests directory. You may be using this a lot so make sure the location is something you can easily remember. The Standalone Selenium Server jar files for 2.x versions (2.53 has been recently tested) can be downloaded from:

To run it, open a dedicated terminal window and type the line similar to this example:

# java -jar ../selenium/selenium-server-standalone-2.53.1.jar

For complete documentation, please go to:

Configure the VNC server

If it isn’t already there, create a .vnc directory in your home directory:

$ mkdir ~/.vnc
Set a password

Using the vncpasswd utility, enter your desired vnc password and save it to a file:

$ vncpasswd ~/.vnc/passwd

The ~/.vnc/passwd file stores an obfuscated version of the password entered, so you’ll either want to use a memorable password or write the password down. Also, passwords longer than 8 characters will be truncated. More on this Security).

Configure the startup script

Create or modify ~/.vnc/xstartup. This script is run inside the VNC server, and bootstraps the environment. It must be executable, and needs to do the following things:

  • If using chrome/chromdriver, configure the $PATH environment variable so that the selenium server can find the google-chrome and chromedriver binaries
  • Start the window manager (fluxbox)
  • Start the selenium server in a terminal window (xterm, selenium-server-standalone-VERSION.jar)

Here’s an example script that does those things:

#!/bin/sh

# Set up the environment so selenium can find everything it might want
# (namely chrome and chromedriver)
export PATH="/path/to/google/chrome/directory/:/path/to/chromdriver/directory:$PATH"

# Start the window manager
fluxbox &

# Start the selenium server
xterm -maximized -e java -jar /path/to/selenium-server-standalone-VERSION.jar -ensureCleanSession -trustAllSSLCertificates &

Important things: * The script MUST start with #!/bin/sh (or your shell shebang of choice). * The script MUST be executable (chmod +x ~/.vnc/xstartup) * The “-ensureCleanSession -trustAllSSLCertificates” won’t work with the selenium-server which is 3.x.x onward. Start the server ^^^^^^^^^^^^^^^^

$ vncserver :99

This will start a local VNC server, listening on display 99 and port 5999. The string ‘:99’ is all you should need to enter into connection prompts to connect to VNC display 99. This example uses :99, but any other reasonable display number can be used throughout this guide. This server will use the password stored in ~/.vnc/passwd.

View your new desktop

To connect to the server, there are a few tools that you can use. GNOME has a built-in VNC viewer called vinagre, and tigervnc also provides one. Make sure at least one of these is installed (package names are vinagre and tigervnc), and then connect to the VNC server. Both tools have graphical and command-line interfaces.

To connect using either command-line tool, pass the display number as the first argument:

$ vncviewer :99
# -or-
$ vinagre :99

Enter the VNC password that you set [above](Selenium-over-VNC#set-a-password). Once connected, you should see your selenium server running in a maximized xterm window.

Help for the graphical interfaces to these tools is provided by the tools themselves, but they’re pretty straightforward.

Configuring the selenium client

In your existing test environment, have a env.yaml file, with a webdriver key in the browser root key. This should be set to Remote, which is the default from the env.yaml.template it informs the test suite to use the remote selenium server now running inside your VNC server.

We also need to set the Remote options, by setting the desired_capabilities key to have the platform and browsername For Fedora, the platform would be LINUX, but selenium recognizes any of the following (possibly more).

  • WINDOWS
  • XP
  • VISTA
  • MAC
  • LINUX
  • UNIX

An example of the yaml is below:

base_url: https://10.11.12.13
browser:
    webdriver: Remote
    webdriver_options:
        desired_capabilities:
            platform: LINUX
            browserName: 'chrome'
            # for the selenium-server version 3.x.x onward you will need to use
            # following capabilities instead of using CLI arguments (uncomment next 2 lines)
            # and do not use '-ensureCleanSession -trustAllSSLCertificates' in java -jar command
            # which is used to launch selenium-server in xstartup script as shown
            # in 'Configure the startup script' section
            # acceptInsecureCerts: true
            # ensureCleanSession: true

Note: If you are using selenium server 3.4.0 then you might see issue related ‘mouseMoveTo’ which is open on GitHub: * https://github.com/SeleniumHQ/selenium/issues/4008 * https://github.com/SeleniumHQ/selenium/issues/3808

Security

Simply put, VNC isn’t very secure. Its connections aren’t encrypted, and its passwords can only be a max of 8 characters long. For this reason, I recommend having the VNC server bind to the loopback interface. Fortunately, this is easily done by passing the -localhost flag to vncserver, like this:

$ vncserver :99 -localhost

No changes need to be made in the way clients are told to connect to support this change, but it prevents other users from connecting to and interacting with this VNC session remotely.

Recording

The recordmydesktop utility can be used to record test interactions for demonstration or review. Continuing with display :99 for this example, recordmydesktop can be invoked like this:

$ recordmydesktop --display :99 --fps 60 -o outfile.ogv

In addition to specifying --display :99, --fps 60 is passed to ensure no steps are missed in the recording. rescordmydesktop’s default framerate has shown to be a little too low to accurately capture all of the actions taken in a test run. Finally, -o is passed to specify the output file.

To record test runs in one shot, the following pattern can be followed (changing the py.test invocation as needed, of course):

$ recordmydesktop --display :99 --fps 60 -o test_label.ogv & py.test -k test_label --highlight; pkill recordmydesktop

Modules

cfme package

Subpackages

cfme.ansible package
Submodules
cfme.ansible.credentials module

Page model for Automation/Anisble/Credentials

class cfme.ansible.credentials.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CredentialAddView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.credentials.AnsibleCredentials(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CredentialsListView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.credentials.Credential(name, credential_type, collection=None, appliance=None, **credentials)[source]

Bases: utils.appliance.Navigatable

A class representing one Embedded Ansible credential in the UI.

delete()[source]
exists
update(updates)[source]
class cfme.ansible.credentials.CredentialAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.credentials.CredentialFormView

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

credential_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.ansible.credentials.CredentialDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.credentials.CredentialsBaseView

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

credential_options

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.credentials.CredentialEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.credentials.CredentialFormView

before_fill(values)[source]
credential_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

input

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.credentials.CredentialFormView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.credentials.CredentialsBaseView

CredentialFormAmazonView = None
CredentialFormDefaultView = None
CredentialFormMachineView = None
CredentialFormScmView = None
CredentialFormVMwareView = None
cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

credential_form

Conditional switchable view implementation.

This widget proxy is useful when you have a form whose parts displayed depend on certain conditions. Eg. when you select certain value from a dropdown, one form is displayed next, when other value is selected, a different form is displayed next. This widget proxy is designed to register those multiple views and then upon accessing decide which view to use based on the registration conditions.

The resulting widget proxy acts similarly like a nested view (if you use view of course).

Example

class SomeForm(View):
    foo = Input('...')
    action_type = Select(name='action_type')

    action_form = ConditionalSwitchableView(reference='action_type')

    # Simple value matching. If Action type 1 is selected in the select, use this view.
    # And if the action_type value does not get matched, use this view as default
    @action_form.register('Action type 1', default=True)
    class ActionType1Form(View):
        widget = Widget()

    # You can use a callable to declare the widget values to compare
    @action_form.register(lambda action_type: action_type == 'Action type 2')
    class ActionType2Form(View):
        widget = Widget()

    # With callable, you can use values from multiple widgets
    @action_form.register(
        lambda action_type, foo: action_type == 'Action type 2' and foo == 2)
    class ActionType2Form(View):
        widget = Widget()

You can see it gives you the flexibility of decision based on the values in the view.

Parameters:
  • reference – For using non-callable conditions, this must be specified. Specifies the name of the widget whose value will be used for comparing non-callable conditions. Supports going across objects using ..
  • ignore_bad_reference – If this is enabled, then when the widget representing the reference is not displayed or otherwise broken, it will then use the default view.
name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.credentials.CredentialsBaseView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_ansible_credentials
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.credentials.CredentialsCollection(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

Collection object for the Credential.

create(name, credential_type, **credentials)[source]
class cfme.ansible.credentials.CredentialsListView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.credentials.CredentialsBaseView

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

credentials

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.ansible.credentials.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CredentialDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.credentials.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CredentialEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.ansible.playbooks module

Page model for Automation/Anisble/Playbooks

class cfme.ansible.playbooks.AnsiblePlaybooks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PlaybooksView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.playbooks.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PlaybookDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.playbooks.Playbook(name, repository, collection)[source]

Bases: utils.appliance.Navigatable

A class representing one Embedded Ansible playbook in the UI.

exists
class cfme.ansible.playbooks.PlaybookBaseView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_ansible_playbooks
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.playbooks.PlaybookDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.playbooks.PlaybookDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.playbooks.PlaybookBaseView

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.ansible.playbooks.PlaybookEntitiesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents the view with different items like hosts.

entity_class
class cfme.ansible.playbooks.PlaybookEntity(parent, name, logger=None)[source]

Bases: widgetastic_manageiq.NonJSBaseEntity

grid_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

list_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tile_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.playbooks.PlaybookGridIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseQuadIconEntity

class cfme.ansible.playbooks.PlaybookListEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseListEntity

class cfme.ansible.playbooks.PlaybookTileIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseTileIconEntity

class cfme.ansible.playbooks.PlaybooksCollection(parent_repository)[source]

Bases: utils.appliance.Navigatable

Collection object for the Playbook.

all()[source]
instantiate(name, repository)[source]
class cfme.ansible.playbooks.PlaybooksToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.playbooks.PlaybooksView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.playbooks.PlaybookBaseView

entities
is_displayed
paginator

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.ansible.repositories module

Page model for Automation/Ansible/Repositories

class cfme.ansible.repositories.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RepositoryAddView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.repositories.AnsibleRepositories(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RepositoryListView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.repositories.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RepositoryDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.repositories.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RepositoryEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.ansible.repositories.Repository(name, url, description=None, scm_credentials=None, scm_branch=None, clean=None, delete_on_update=None, update_on_launch=None, collection=None, appliance=None)[source]

Bases: utils.appliance.Navigatable

A class representing one Embedded Ansible repository in the UI.

db_object
delete()[source]

Delete the repository in the UI.

exists
playbooks
refresh()[source]

Perform a refresh to update the repository.

update(updates)[source]

Update the repository in the UI.

Parameters:updates (dict) – dict of the updates.
class cfme.ansible.repositories.RepositoryAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.repositories.RepositoryFormView

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.ansible.repositories.RepositoryBaseView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_ansible_repositories
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.repositories.RepositoryCollection(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

Collection object for the cfme.ansible.repositories.Repository.

all()[source]

Return all repositories of the appliance.

Returns: a list of cfme.ansible.repositories.Repository instances

create(name, url, description=None, scm_credentials=None, scm_branch=None, clean=None, delete_on_update=None, update_on_launch=None)[source]

Add an ansible repository in the UI and return a Repository object.

Parameters:
  • name (str) – name of the repository
  • url (str) – url of the repository
  • description (str) – description of the repository
  • scm_credentials (str) – credentials of the repository
  • scm_branch (str) – branch name
  • clean (bool) – clean
  • delete_on_update (bool) – delete the repo at each update
  • update_on_launch (bool) – update the repo at each launch

Returns: an instance of cfme.ansible.repositories.Repository

delete(*repositories)[source]

Delete one or more ansible repositories in the UI.

Parameters:repositories – a list of cfme.ansible.repositories.Repository instances to delete
Raises:ValueError – if some of the repositories were not found in the UI
instantiate(name, url, description=None, scm_credentials=None, scm_branch=None, clean=None, delete_on_update=None, update_on_launch=None)[source]
class cfme.ansible.repositories.RepositoryDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.repositories.RepositoryBaseView

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.ansible.repositories.RepositoryEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.repositories.RepositoryFormView

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.repositories.RepositoryFormView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.repositories.RepositoryBaseView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

clean

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

delete_on_update

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

scm_branch

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

scm_credentials

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

update_on_launch

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

url

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.ansible.repositories.RepositoryListView(parent, logger=None, **kwargs)[source]

Bases: cfme.ansible.repositories.RepositoryBaseView

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
pagination_pane

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
repositories

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents
cfme.automate package
Subpackages
cfme.automate.explorer package
Submodules
cfme.automate.explorer.common module
class cfme.automate.explorer.common.Copiable[source]

Bases: object

copy_to(domain, new_name=None, replace=None, cancel=False)[source]
class cfme.automate.explorer.common.CopyViewBase(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

copy_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

namespace

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

new_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

override_existing

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

override_source

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

to_domain_select

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

to_domain_text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.automate.explorer.domain module
class cfme.automate.explorer.domain.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DomainAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.domain.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DomainListView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.domain.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DomainDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.domain.Domain(name, description, enabled=None, locked=None, collection=None, git_repository=None, git_checkout_type=None, git_checkout_value=None, db_id=None, appliance=None)[source]

Bases: utils.appliance.Navigatable, widgetastic.utils.Fillable

A class representing one Domain in the UI.

as_fill_value()[source]
db_id
db_object
delete(cancel=False)[source]
delete_if_exists()[source]
domain
enabled
exists
git_checkout_type
git_checkout_value
git_repository

Returns an associated git repository object. None if no git repo associated.

lock()[source]
locked
namespaces
parent
table_display_name
tree_display_name
tree_path
unlock()[source]
update(updates)[source]
class cfme.automate.explorer.domain.DomainAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.domain.DomainForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.automate.explorer.domain.DomainCollection(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

Collection object for the Domain.

all()[source]
create(name=None, description=None, enabled=None, cancel=False)[source]
delete(*domains)[source]
instantiate(name, description=None, enabled=None, git_repository=None, git_checkout_type=None, git_checkout_value=None, db_id=None)[source]
set_order(items)[source]
tree_path = ['Datastore']
class cfme.automate.explorer.domain.DomainDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

is_displayed
namespaces

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.domain.DomainEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.domain.DomainForm

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.domain.DomainForm(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

enabled

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.domain.DomainListView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

domains

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.domain.DomainPriorityView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

domains

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.domain.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DomainEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.domain.Priority(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DomainPriorityView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.automate.explorer.domain.generate_updown(title)[source]
cfme.automate.explorer.instance module
class cfme.automate.explorer.instance.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceAddView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.instance.Copy(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceCopyView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.instance.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.instance.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.instance.Instance(collection, name, display_name, description, fields)[source]

Bases: utils.appliance.Navigatable, cfme.automate.explorer.common.Copiable

db_id
db_object
delete(cancel=False)[source]
delete_if_exists()[source]
description
display_name
domain
exists
klass
namespace
parent
tree_path
tree_path_name_only
update(updates)[source]
class cfme.automate.explorer.instance.InstanceAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

fields

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.instance.InstanceCollection(parent_class)[source]

Bases: utils.appliance.Navigatable

create(name=None, display_name=None, description=None, fields=None, cancel=False)[source]
delete(*instances)[source]
instantiate(name=None, display_name=None, description=None, fields=None)[source]
tree_path
class cfme.automate.explorer.instance.InstanceCopyView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView, cfme.automate.explorer.common.CopyViewBase

is_displayed
class cfme.automate.explorer.instance.InstanceDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

is_displayed
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.instance.InstanceEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

fields

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.automate.explorer.klass module
class cfme.automate.explorer.klass.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ClassAddView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.klass.Class(collection, name, display_name, description)[source]

Bases: utils.appliance.Navigatable, cfme.automate.explorer.common.Copiable

db_id
db_object
delete(cancel=False)[source]
delete_if_exists()[source]
description
display_name
domain
exists
fqdn
instances
methods
namespace
parent
pure_tree_path
schema
tree_path
tree_path_name_only
update(updates)[source]
class cfme.automate.explorer.klass.ClassAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.klass.ClassForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.automate.explorer.klass.ClassCollection(parent_namespace)[source]

Bases: utils.appliance.Navigatable

create(name=None, display_name=None, description=None, cancel=False)[source]
delete(*classes)[source]
instantiate(name=None, display_name=None, description=None)[source]
tree_path
class cfme.automate.explorer.klass.ClassCopyView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView, cfme.automate.explorer.common.CopyViewBase

is_displayed
class cfme.automate.explorer.klass.ClassDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

instances

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
methods

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

schema

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.klass.ClassEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.klass.ClassForm

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.klass.ClassForm(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.klass.ClassSchema(klass)[source]

Bases: utils.appliance.Navigatable

FIELD_NAMES = ['name', 'type', 'data_type', 'default_value', 'display_name', 'description', 'substitute', 'collect', 'message', 'on_entry', 'on_exit', 'on_error', 'max_retries', 'max_time']
add_field(**kwargs)[source]
add_fields(*fields)[source]
delete_field(field)[source]
delete_fields(*fields)[source]
schema_field_names
class cfme.automate.explorer.klass.ClassSchemaEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.klass.ClassDetailsView

is_displayed
schema

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.klass.Copy(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ClassCopyView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.klass.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ClassDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.klass.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ClassEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.klass.EditSchema(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ClassSchemaEditView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.automate.explorer.method module
class cfme.automate.explorer.method.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MethodAddView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.method.Copy(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MethodCopyView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.method.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MethodDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.method.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MethodEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.method.Method(collection, name, display_name, location, script, data)[source]

Bases: utils.appliance.Navigatable, cfme.automate.explorer.common.Copiable

db_id
db_object
delete(cancel=False)[source]
delete_if_exists()[source]
display_name
domain
exists
klass
namespace
parent
tree_path
tree_path_name_only
update(updates)[source]
class cfme.automate.explorer.method.MethodAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

data

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
location

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

script

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

validate_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.method.MethodCollection(parent_class)[source]

Bases: utils.appliance.Navigatable

create(name=None, display_name=None, location='inline', script=None, data=None, cancel=False, validate=True)[source]
delete(*methods)[source]
instantiate(name=None, display_name=None, location=None, script=None, data=None)[source]
tree_path
class cfme.automate.explorer.method.MethodCopyView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView, cfme.automate.explorer.common.CopyViewBase

is_displayed
class cfme.automate.explorer.method.MethodDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

created_on

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

fqdn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
location

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.method.MethodEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

data

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
location

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

script

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

validate_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.automate.explorer.namespace module
class cfme.automate.explorer.namespace.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NamespaceAddView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.namespace.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NamespaceDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.namespace.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NamespaceEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.namespace.Namespace(collection, name, description)[source]

Bases: utils.appliance.Navigatable

classes
db_id
db_object
delete(cancel=False)[source]
delete_if_exists()[source]
description
domain
exists
namespaces
parent
tree_path
update(updates)[source]
class cfme.automate.explorer.namespace.NamespaceAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.namespace.NamespaceForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.automate.explorer.namespace.NamespaceCollection(parent)[source]

Bases: utils.appliance.Navigatable

create(name=None, description=None, cancel=False)[source]
delete(*namespaces)[source]
instantiate(name=None, description=None)[source]
tree_path
class cfme.automate.explorer.namespace.NamespaceDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

is_displayed
namespaces

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.namespace.NamespaceEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.namespace.NamespaceForm

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.explorer.namespace.NamespaceForm(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.explorer.AutomateExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents
class cfme.automate.explorer.AutomateExplorer(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AutomateExplorerView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.explorer.AutomateExplorerView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

datastore

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_explorer
is_displayed
cfme.automate.explorer.check_tree_path(actual, desired)[source]
Submodules
cfme.automate.buttons module
class cfme.automate.buttons.Button(group=None, text=None, hover=None, dialog=None, system=None, request=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable

Create,Edit and Delete buttons under a Button

Parameters:
  • group – Group where this button belongs.
  • text – The button name.
  • hover – The button hover text.
  • dialog – The dialog to be selected for a button.
  • system – System or Processes , DropDown to choose Automation/Request.
create()[source]
delete(cancel=False)[source]
delete_if_exists()[source]
exists
update(updates)[source]
class cfme.automate.buttons.ButtonAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ButtonsAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonDetailView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

dialog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hover

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
message

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

request

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

show

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

system

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.ButtonDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ButtonDetailView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditButtonView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

dialog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hover

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

image

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

message

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

request

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

system

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.ButtonGroup(text=None, hover=None, type=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable

Create,Edit and Delete Button Groups

Parameters:
  • text – The button Group name.
  • hover – The button group hover text.
  • type – The object type.
CLUSTER = 'Cluster'
DATASTORE = 'Datastore'
HOST = 'Host / Node'
PROVIDER = 'Provider'
SERVICE = 'Service'
TEMPLATE = 'VM Template and Image'
VM_INSTANCE = 'VM and Instance'
create()[source]
delete(cancel=False)[source]
delete_if_exists()[source]
exists
update(updates)[source]
class cfme.automate.buttons.ButtonGroupAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ButtonsAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonGroupDetailView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

hover

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.ButtonGroupDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ButtonGroupDetailView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonGroupEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditButtonGroupView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonGroupFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hover

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

image

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.ButtonGroupNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewButtonGroupView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonGroupObjectType(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ButtonGroupObjectTypeView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonGroupObjectTypeView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.ButtonNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewButtonView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.buttons.ButtonsAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.EditButtonGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.buttons.ButtonGroupFormCommon

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.EditButtonView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.buttons.ButtonFormCommon

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.NewButtonGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.buttons.ButtonGroupFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.buttons.NewButtonView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.buttons.ButtonFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.automate.dialog_box module
class cfme.automate.dialog_box.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddBoxView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.dialog_box.AddBoxView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_box.BoxForm

AddBox View.

is_displayed
plus_btn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.dialog_box.Box(collection, box_label, box_desc)[source]

Bases: utils.appliance.Navigatable

A class representing one Box of dialog.

elements
parent

returns the parent object - Tab

tab
tree_path
class cfme.automate.dialog_box.BoxCollection(parent, appliance=None)[source]

Bases: utils.appliance.Navigatable

create(box_label=None, box_desc=None)[source]

Create box method. :param box_label and box_description.:

instantiate(box_label=None, box_desc=None)[source]
tree_path
class cfme.automate.dialog_box.BoxForm(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_tab.AddTabView

box_desc

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

box_label

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.dialog_box.EditBoxView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_box.BoxForm

EditBox View.

is_displayed
cfme.automate.dialog_element module
class cfme.automate.dialog_element.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddElementView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.dialog_element.AddElementView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_element.ElementForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.automate.dialog_element.DetailsDialogView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.dialog_element.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditElementView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

class cfme.automate.dialog_element.EditElementView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_element.ElementForm

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.dialog_element.Element(collection, element_data)[source]

Bases: utils.appliance.Navigatable

A class representing one Element of a dialog.

add_another_element(element)[source]

Method to add element.

dialog
element_loc(element_data)[source]
parent
reorder_elements(add_element, second_element, element_data)[source]
Method to add element and interchange element positions.
This method updates a dialog and adds a second element.The position of two elements are then interchanged to test for error.
Parameters:
  • - flag if second element needs to be added. (add_element) –
  • - The second element to be added to the dialog. (second_element) –
  • - Already existing first element's data. (element_data) –
tree_path
class cfme.automate.dialog_element.ElementCollection(parent)[source]

Bases: utils.appliance.Navigatable

create(element_data=None)[source]
instantiate(element_data=None)[source]
set_element_type(view, element)[source]

Method to add element type.Depending on their type the subfields varies.

Parameters:each_element – subfields depending on element type.
tree_path
class cfme.automate.dialog_element.ElementForm(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_box.AddBoxView

add_entry_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

apply_btn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

bt_tree

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
choose_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

default_text_box

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

default_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

dynamic_chkbox

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

dynamic_tree

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
ele_desc

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ele_label

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ele_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

element_tree

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
entry_description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entry_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entry_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

field_category

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

field_entry_point

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

field_past_dates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

field_required

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

field_show_refresh_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

text_area

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.automate.dialog_tab module
class cfme.automate.dialog_tab.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddTabView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.dialog_tab.AddTabView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_tab.TabForm

is_displayed
plus_btn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.dialog_tab.DetailsTabView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_tab.TabForm

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.dialog_tab.EditTabView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.dialog_tab.TabForm

is_displayed
class cfme.automate.dialog_tab.Tab(collection, tab_label, tab_desc)[source]

Bases: utils.appliance.Navigatable

A class representing one Tab in the UI.

boxes
dialog

Returns parent object - Dialog

parent

Returns parent object - Dialog

tree_path
class cfme.automate.dialog_tab.TabCollection(parent)[source]

Bases: utils.appliance.Navigatable

add_tab()[source]
create(tab_label=None, tab_desc=None)[source]

Create tab method

instantiate(tab_label=None, tab_desc=None)[source]
tree_path
class cfme.automate.dialog_tab.TabForm(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.service_dialogs.AddDialogView

tab_desc

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tab_label

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.automate.import_export module
class cfme.automate.import_export.AutomateGitRepository(url=None, username=None, password=None, verify_ssl=None, appliance=None)[source]

Bases: utils.appliance.Navigatable

Represents an Automate git repository. This entity is not represented in UI as it is, but only in database. But by representing it it makes the code changes for domain much simpler.

fill_values_branch_select(branch, tag)[source]

Processes the args into a dictionary to be filled in the selection dialog.

fill_values_repo_add
classmethod from_db(db_id, appliance=None)[source]
import_domain_from(branch=None, tag=None)[source]

Import the domain from git using the Import/Export UI.

Parameters:
  • branch – If you import from a branch, specify the origin/branchname
  • tag – If you import from a tag, specify its name.
Returns:

Instance of cfme.automate.explorer.domain.Domain

Important! branch and tag are mutually exclusive.

class cfme.automate.import_export.GitImportSelectorView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.AutomateImportExportBaseView

branch

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
submit

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.automate.provisioning_dialogs module
class cfme.automate.provisioning_dialogs.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvDiagAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.provisioning_dialogs.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvDiagAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.provisioning_dialogs.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvDiagDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.provisioning_dialogs.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvDiagEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.provisioning_dialogs.ProvDiagAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.provisioning_dialogs.ProvDiagView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvDiagAllEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

All entities view - no view selector, not using BaseEntitiesView

paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvDiagAllToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Toolbar with singular configuration dropdown

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvDiagAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.provisioning_dialogs.ProvDiagView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvDiagDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Entities for details page

basic_info

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

content

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvDiagDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.provisioning_dialogs.ProvDiagView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvDiagEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.provisioning_dialogs.ProvDiagView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvDiagForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Base form with common widgets for add and edit

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

content

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

diag_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvDiagView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

in_customization
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.provisioning_dialogs.ProvisioningDialog(diag_type, name=None, description=None, content=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

ALLOWED_TYPES = set(['VM Migrate', 'Configured System Provision', 'VM Provision', 'Host Provision'])
HOST_PROVISION = 'Host Provision'
SYSTEM_PROVISION = 'Configured System Provision'
VM_MIGRATE = 'VM Migrate'
VM_PROVISION = 'VM Provision'
create(cancel=False)[source]
delete(cancel=False)[source]
exists
pretty_attrs = ['name', 'description', 'diag_type', 'content']
update(updates, cancel=False, reset=False)[source]
cfme.automate.service_dialogs module
class cfme.automate.service_dialogs.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddDialogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.service_dialogs.AddDialogView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.service_dialogs.DialogForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
plus_btn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.service_dialogs.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DialogsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.service_dialogs.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsDialogView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.service_dialogs.DetailsDialogView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.service_dialogs.Dialog(label, description=None, submit=False, cancel=False, collection=None, appliance=None)[source]

Bases: utils.appliance.Navigatable, widgetastic.utils.Fillable

A class representing one Domain in the UI.

as_fill_value()[source]
delete()[source]

Delete dialog method

delete_if_exists()[source]
dialog
exists

Returns True if dialog exists

parent
tabs
tree_path
update(updates)[source]

Update dialog method

class cfme.automate.service_dialogs.DialogCollection(appliance=None)[source]

Bases: utils.appliance.Navigatable

Collection object for the Dialog.

create(label=None, description=None, submit=False, cancel=False)[source]

Create dialog label method

instantiate(label, description=None, submit=False, cancel=False)[source]
tree_path = ['All Dialogs']
class cfme.automate.service_dialogs.DialogForm(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

label

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

plus_btn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

submit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.service_dialogs.DialogsView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.AutomateCustomizationView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.automate.service_dialogs.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditDialogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.service_dialogs.EditDialogView(parent, logger=None, **kwargs)[source]

Bases: cfme.automate.service_dialogs.DialogForm

element_tree

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.automate.simulation module
cfme.automate.simulation.simulate(instance=None, message=None, request=None, target_type=None, target_object=None, execute_methods=None, attributes_values=None, pre_clear=True, appliance=None)[source]

Runs the simulation of specified Automate object.

Module contents
class cfme.automate.AutomateCustomization(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AutomateCustomizationView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.automate.AutomateCustomizationView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

buttons

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

import_export

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_customization
is_displayed
provisioning_dialogs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

service_dialogs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.base package
Submodules
cfme.base.credential module
class cfme.base.credential.AzureCredential(principal, secret, verify_secret=None, domain=None, **ignore)[source]

Bases: cfme.base.credential.Credential

class cfme.base.credential.CANDUCredential(principal, secret, verify_secret=None, domain=None, **ignore)[source]

Bases: cfme.base.credential.Credential

class cfme.base.credential.Credential(principal, secret, verify_secret=None, domain=None, **ignore)[source]

Bases: utils.pretty.Pretty, utils.update.Updateable, cfme.base.credential.FromConfigMixin

A class to fill in credentials

Parameters:
  • principal – user name
  • secret – password
  • verify_secret – password
  • domain – concatenated with principal if defined
form
pretty_attrs = ['principal', 'secret']
view_value_mapping

used for filling forms like add/edit provider form Returns: dict

class cfme.base.credential.EventsCredential(principal, secret, verify_secret=None, domain=None, **ignore)[source]

Bases: cfme.base.credential.Credential

class cfme.base.credential.FromConfigMixin[source]

Bases: object

classmethod from_config(key)[source]

helper function which allows to construct credential object from credentials.eyaml

Parameters:key – credential key

Returns: credential object

classmethod from_plaintext(creds)[source]

helper function which allows to construct credential class from plaintext dict

Parameters:creds – dict

Returns: credential object

static rename_properties(creds)[source]

helper function to make properties have same names in credential objects. :param creds: dict

Returns: updated dict

class cfme.base.credential.SSHCredential(principal, secret, verify_secret=None, domain=None, **ignore)[source]

Bases: cfme.base.credential.Credential

view_value_mapping

used for filling forms like add/edit provider form Returns: dict

class cfme.base.credential.ServiceAccountCredential(service_account)[source]

Bases: utils.pretty.Pretty, utils.update.Updateable

A class to fill in credentials

Parameters:service_account – service account string
form
classmethod from_config(key)[source]
pretty_attrs = ['service_account']
view_value_mapping

used for filling forms like add/edit provider form Returns: dict

class cfme.base.credential.TokenCredential(token, verify_token=None, **kwargs)[source]

Bases: utils.pretty.Pretty, utils.update.Updateable, cfme.base.credential.FromConfigMixin

A class to fill in credentials

Parameters:
  • token – identification token
  • verify_token – token once more
form
pretty_attrs = ['token']
view_value_mapping

used for filling forms like add/edit provider form Returns: dict

cfme.base.credential.provider_credential_form()[source]
cfme.base.login module
class cfme.base.login.BaseLoggedInPage(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

This page should be subclassed by any page that models any other page that is available as logged in.

CSRF_TOKEN = '//meta[@name="csrf-token"]'
csrf_token
current_fullname
current_username
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

help

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
logged_in
logged_in_as_current_user
logged_in_as_user(user)[source]
logged_out
logout()[source]
navigation

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

settings

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.base.ssui module
class cfme.base.ssui.LoggedIn(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ssui.SSUINavigateStep

step()[source]
class cfme.base.ssui.LoginPage(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

login

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ssui.LoginScreen(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ssui.SSUINavigateStep

VIEW

alias of LoginPage

prerequisite()[source]
step()[source]
cfme.base.ssui.address(self)[source]
cfme.base.ssui.login(self, user=None, **kwargs)[source]
cfme.base.ui module
class cfme.base.ui.About(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AboutView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Advanced(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.AuditLog(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Authentication(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.AutomateImportExport(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AutomateImportExportView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.AutomateImportExportBaseView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_import_export
is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.AutomateImportExportView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.AutomateImportExportBaseView

export_all

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

import_file

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

import_git

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_all

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.AutomateSimulation(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AutomateSimulationView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.AutomateSimulationView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

avp

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

execute_methods

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

instance

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
message

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

request

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

result_tree

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
submit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

target_object

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

target_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.CFMELog(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Chargeback(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ChargebackView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.base.ui.Configuration(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ConfigurationView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ConfigurationView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

accordions

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_configuration
is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.CustomLogos(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Dashboard(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DashboardView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Diagnostics(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerDiagnosticsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.DiagnosticsCollectLogs(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DiagnosticsCollectLogsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.DiagnosticsCollectLogsEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DiagnosticsCollectLogsEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.DiagnosticsCollectLogsEditSlave(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DiagnosticsCollectLogsEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.DiagnosticsCollectLogsEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.DiagnosticsCollectLogsView

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

confirm_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

depot_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

depot_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

uri

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

validate

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.DiagnosticsCollectLogsSlave(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DiagnosticsCollectLogsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.DiagnosticsCollectLogsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ServerDiagnosticsView

collect

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

edit

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
last_log_collection

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

last_log_message

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

log_depot_uri

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.DiagnosticsDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.DiagnosticsWorkers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Documentation(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DocView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Import(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ImportTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.LoggedIn(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of BaseLoggedInPage

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.LoginPage(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

back

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

change_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

current_fullname
current_username
details

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hide_update_password()[source]
is_displayed
log_in(user, method='click_on_login')[source]
logged_in
logged_in_as_current_user
logged_in_as_user(user)[source]
logged_out
login

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

login_admin(**kwargs)[source]
new_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

show_update_password()[source]
submit_login(method='click_on_login')[source]
update_password(username, password, new_password, verify_password=None, method='click_on_login')[source]
username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

verify_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.LoginScreen(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of LoginPage

prerequisite()[source]
step()[source]
class cfme.base.ui.MySettings(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.MySettingsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

is_displayed
tabs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.ProductionLog(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RSS(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RSSView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDiagnostics(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionDiagnosticsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDiagnosticsDatabase(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDiagnosticsOrphanedData(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDiagnosticsReplication(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDiagnosticsRolesByServers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDiagnosticsServers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDiagnosticsServersByRoles(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionDiagnosticsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

database

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
orphaneddata

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

replication

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

rolesbyservers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

servers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

serversbyroles

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

zones

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.RegionDiagnosticsZones(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RegionDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.RegionView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

canducollection

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

companycategories

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

companytags

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

details

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

imports

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

importtags

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
maptags

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

redhatupdates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.RegionZones(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneListView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ServerDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ServerDiagnosticsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

auditlog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfmelog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

collectlogs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
productionlog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

summary

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

timelines

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

utilization

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

workers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.ServerView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

advanced

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

authentication

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

customlogos

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
server

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

workers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.Tasks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TasksView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Utilization(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerDiagnosticsView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.Workers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServerView

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneAddView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ZoneForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.base.ui.ZoneCANDUGapCollection(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneDiagnosticsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.base.ui.ZoneDiagnostics(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneDiagnosticsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneDiagnosticsCollectLogs(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneDiagnosticsCollectLogsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneDiagnosticsCollectLogsEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DiagnosticsCollectLogsEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneDiagnosticsCollectLogsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.DiagnosticsCollectLogsView

edit

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.base.ui.ZoneDiagnosticsRolesByServers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneDiagnosticsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneDiagnosticsServers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneDiagnosticsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneDiagnosticsServersByRoles(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneDiagnosticsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneDiagnosticsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

candugapcollection

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

collectlogs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
rolesbyservers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

servers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

serversbyroles

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.ZoneEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ZoneEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.base.ui.ZoneEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ZoneForm

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.ZoneForm(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

max_scans

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ntp_server_1

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ntp_server_2

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ntp_server_3

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smartproxy_ip

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

verify

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.base.ui.ZoneListView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.base.ui.address(self)[source]
cfme.base.ui.automate_menu_name(appliance)[source]
cfme.base.ui.create(self, name=None, description=None, smartproxy_ip=None, ntp_servers=None, max_scans=None, user=None, cancel=False)[source]
cfme.base.ui.current_full_name(self)[source]

Returns the current username. Returns: the current username.

cfme.base.ui.delete(self, cancel=False)[source]

Delete the Zone represented by this object.

Parameters:cancel – Whether to click on the cancel button in the pop-up.
cfme.base.ui.exists(self)[source]
cfme.base.ui.logged_in(self)[source]
cfme.base.ui.login(self, user=None, submit_method='_js_auth_fn')[source]

Login to CFME with the given username and password. Optionally, submit_method can be press_enter_after_password to use the enter key to login, rather than clicking the button. :param user: The username to fill in the username field. :param password: The password to fill in the password field. :param submit_method: A function to call after the username and password have been input.

Raises:RuntimeError – If the login fails, ie. if a flash message appears
cfme.base.ui.login_admin(self, **kwargs)[source]

Convenience function to log into CFME using the admin credentials from the yamls. :param kwargs: A dict of keyword arguments to supply to the login() method.

cfme.base.ui.logout(self)[source]

Logs out of CFME.

cfme.base.ui.update(self, updates)[source]
Module contents
class cfme.base.Region(appliance, number=0)[source]

Bases: utils.appliance.Navigatable, sentaku.modeling.ElementMixin

settings_string
class cfme.base.Server(appliance, zone=None, name='EVM', sid=1)[source]

Bases: utils.appliance.Navigatable, sentaku.modeling.ElementMixin

address

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
current_full_name

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
current_username

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
logged_in

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
login

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
login_admin

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
logout

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
update_password

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
class cfme.base.Zone(appliance, region=None, name=None, description=None, smartproxy_ip=None, ntp_servers=None, max_scans=None, user=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable, sentaku.modeling.ElementMixin

Configure/Configuration/Region/Zones functionality

Create/Read/Update/Delete functionality.

delete

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
exists
pretty_attrs = ['name', 'description', 'smartproxy_ip', 'ntp_servers', 'max_scans', 'user']
update

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
class cfme.base.ZoneCollection(appliance, region=None)[source]

Bases: utils.appliance.Navigatable, sentaku.modeling.ElementMixin

create

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
cfme.cloud package
Subpackages
cfme.cloud.instance package
Submodules
cfme.cloud.instance.azure module
class cfme.cloud.instance.azure.AzureInstance(name, provider, template_name=None, appliance=None)[source]

Bases: cfme.cloud.instance.Instance

DELETE = 'Delete'
POWER_ON = 'Start'
RESTART = 'Restart'
SOFT_REBOOT = 'Soft Reboot'
START = 'Start'
STATE_ARCHIVED = 'archived'
STATE_OFF = 'off'
STATE_ON = 'on'
STATE_SUSPENDED = 'suspended'
STATE_TERMINATED = 'terminated'
STATE_UNKNOWN = 'unknown'
STOP = 'Stop'
SUSPEND = 'Suspend'
TERMINATE = 'Delete'
create(cancel=False, **prov_fill_kwargs)[source]

Provisions an Azure instance with the given properties through CFME

Parameters:
  • cancel – Clicks the cancel button if True, otherwise clicks the submit button (Defaults to False)
  • prov_fill_kwargs – dictionary of provisioning field/value pairs

Note

For more optional keyword arguments, see cfme.cloud.provisioning.ProvisioningForm

power_control_from_provider(option)[source]

Power control the instance from the provider

Parameters:option – power control action to take against instance
Raises:OptionNotAvailable – option param must have proper value
ui_powerstates_available
ui_powerstates_unavailable
cfme.cloud.instance.ec2 module
class cfme.cloud.instance.ec2.EC2Instance(name, provider, template_name=None, appliance=None)[source]

Bases: cfme.cloud.instance.Instance

DELETE = 'Delete'
POWER_ON = 'Start'
RESTART = 'Restart'
SOFT_REBOOT = 'Soft Reboot'
START = 'Start'
STATE_ARCHIVED = 'archived'
STATE_OFF = 'off'
STATE_ON = 'on'
STATE_SUSPENDED = 'suspended'
STATE_TERMINATED = 'terminated'
STATE_UNKNOWN = 'unknown'
STOP = 'Stop'
TERMINATE = 'Delete'
create(cancel=False, **prov_fill_kwargs)[source]

Provisions an EC2 instance with the given properties through CFME

Parameters:
  • cancel – Clicks the cancel button if True, otherwise clicks the submit button (Defaults to False)
  • prov_fill_kwargs – dictionary of provisioning field/value pairs

Note

For more optional keyword arguments, see cfme.cloud.provisioning.ProvisioningForm

power_control_from_provider(option)[source]

Power control the instance from the provider

Parameters:option – power control action to take against instance
Raises:OptionNotAvailable – option param must have proper value
ui_powerstates_available
ui_powerstates_unavailable
cfme.cloud.instance.gce module
class cfme.cloud.instance.gce.GCEInstance(name, provider, template_name=None, appliance=None)[source]

Bases: cfme.cloud.instance.Instance

DELETE = 'Delete'
POWER_ON = 'Start'
RESTART = 'Restart'
SOFT_REBOOT = 'Soft Reboot'
START = 'Start'
STATE_ARCHIVED = 'archived'
STATE_OFF = 'off'
STATE_ON = 'on'
STATE_SUSPENDED = 'suspended'
STATE_TERMINATED = 'terminated'
STATE_UNKNOWN = 'unknown'
STOP = 'Stop'
TERMINATE = 'Delete'
create(cancel=False, **prov_fill_kwargs)[source]

Provisions an GCE instance with the given properties through CFME

Parameters:
  • cancel – Clicks the cancel button if True, otherwise clicks the submit button (Defaults to False)
  • prov_fill_kwargs – dictionary of provisioning field/value pairs

Note

For more optional keyword arguments, see cfme.cloud.provisioning.ProvisioningForm

power_control_from_provider(option)[source]

Power control the instance from the provider

Parameters:option – power control action to take against instance
Raises:OptionNotAvailable – option param must have proper value
ui_powerstates_available
ui_powerstates_unavailable
cfme.cloud.instance.image module
class cfme.cloud.instance.image.Image(name, provider, template_name=None, appliance=None)[source]

Bases: cfme.common.vm.Template, utils.appliance.Navigatable, cfme.common.WidgetasticTaggable

ALL_LIST_LOCATION = 'clouds_images'
QUADICON_TYPE = 'image'
TO_OPEN_EDIT = 'Edit this Image'
exists

Whether the image exists in CFME

class cfme.cloud.instance.image.ImageAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ImageAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.image.ImageAllForProvider(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ImageProviderAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.image.ImageAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

View for the Image collection

entities
is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.image.ImageDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ImageDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.instance.image.ImageDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

compliance

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

security

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.image.ImageDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Toolbar view for image collection

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.image.ImageDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

View for an Image

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.image.ImageEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.image.ImageEditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.image.ImageManagePolicies(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ManagePoliciesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.image.ImagePolicySimulation(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PolicySimulationView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.image.ImageProviderAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

View for the Image collection

entities
is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.image.ImageProvisionImage(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ImageProvisionView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.image.ImageProvisionView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

View for provisioning image, built from common provisioning form. No before_fill, image already selected

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.instance.image.ImageSetOwnership(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SetOwnershipView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.image.ImageToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Toolbar view for image collection

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.cloud.instance.openstack module
class cfme.cloud.instance.openstack.AddFloatingIP(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddFloatingIPView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.instance.openstack.AddFloatingIPView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.instance.openstack.AttachVolume(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AttachVolumeView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.instance.openstack.AttachVolumeView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.instance.openstack.DetachVolume(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetachVolumeView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.instance.openstack.DetachVolumeView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.instance.openstack.Evacuate(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EvacuateView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.instance.openstack.EvacuateView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.instance.openstack.Migrate(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MigrateView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.instance.openstack.MigrateView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.instance.openstack.OpenStackInstance(name, provider, template_name=None, appliance=None)[source]

Bases: cfme.cloud.instance.Instance

DELETE = 'Delete'
HARD_REBOOT = 'Hard Reboot'
PAUSE = 'Pause'
POWER_ON = 'Start'
RESTART = 'Restart'
SHELVE = 'Shelve'
SHELVE_OFFLOAD = 'Shelve Offload'
SOFT_REBOOT = 'Soft Reboot'
START = 'Start'
STATE_ARCHIVED = 'archived'
STATE_ERROR = 'non-operational'
STATE_OFF = 'off'
STATE_ON = 'on'
STATE_PAUSED = 'paused'
STATE_REBOOTING = 'reboot_in_progress'
STATE_SHELVED = 'shelved'
STATE_SHELVED_OFFLOAD = 'shelved_offloaded'
STATE_SUSPENDED = 'suspended'
STATE_TERMINATED = 'terminated'
STATE_UNKNOWN = 'unknown'
STOP = 'Stop'
SUSPEND = 'Suspend'
TERMINATE = 'Delete'
create(cancel=False, **prov_fill_kwargs)[source]

Provisions an OpenStack instance with the given properties through CFME

Parameters:
  • cancel – Clicks the cancel button if True, otherwise clicks the submit button (Defaults to False)
  • prov_fill_kwargs – dictionary of provisioning field/value pairs

Note

For more optional keyword arguments, see cfme.cloud.provisioning.ProvisioningForm

power_control_from_provider(option)[source]

Power control the instance from the provider

Parameters:option – power control action to take against instance
Raises:OptionNotAvailable – option param must have proper value
ui_powerstates_available
ui_powerstates_unavailable
class cfme.cloud.instance.openstack.Reconfigure(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ReconfigureView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.instance.openstack.ReconfigureView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.instance.openstack.RemoveFloatingIP(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RemoveFloatingIPView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.instance.openstack.RemoveFloatingIPView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.instance.openstack.RightSize(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RightSizeView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
Module contents
class cfme.cloud.instance.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)[source]
step()[source]
class cfme.cloud.instance.AllForProvider(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceProviderAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)[source]
step(*args, **kwargs)[source]
class cfme.cloud.instance.CloudInstanceView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Base view for header/nav check, inherit for navigatable views

in_cloud_instance
class cfme.cloud.instance.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)[source]
step()[source]
class cfme.cloud.instance.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.EditManagementEngineRelationship(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ManagementEngineView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.Instance(name, provider, template_name=None, appliance=None)[source]

Bases: cfme.common.vm.VM, utils.appliance.Navigatable

Represents a generic instance in CFME. This class is used if none of the inherited classes will match.

Parameters:
  • name – Name of the instance
  • provider – cfme.cloud.provider.Provider object
  • template_name – Name of the template to use for provisioning
  • appliance – :py:class: utils.appliance.IPAppliance object

Note

This class cannot be instantiated. Use instance_factory() instead.

ALL_LIST_LOCATION = 'clouds_instances'
PROVISION_CANCEL = 'Add of new VM Provision Request was cancelled by the user'
PROVISION_START = 'VM Provision Request was Submitted, you will be notified when your VMs are ready'
QUADICON_TYPE = 'instance'
REMOVE_SINGLE = 'Remove Instance'
TO_OPEN_EDIT = 'Edit this Instance'
TO_RETIRE = 'Retire this Instance'
VM_TYPE = 'Instance'
create(form_values, cancel=False)[source]

Provisions an instance with the given properties through CFME

Parameters:form_values – dictionary of form values for provisioning, structured into tabs

Note

Calling create on a sub-class of instance will generate the properly formatted dictionary when the correct fields are supplied.

exists
find_quadicon(**kwargs)[source]

Find and return a quadicon belonging to a specific instance

TODO: remove this method and refactor callers to use view entities instead

Args: Returns: entity of appropriate type

get_collection_via_rest()[source]
get_vm_via_rest()[source]
on_details(force=False)[source]

A function to determine if the browser is already on the proper instance details page.

An instance may not be assigned to a provider if archived or orphaned
If no provider is listed, default to False since we may be on the details page for an instance on the wrong provider.
power_control_from_cfme(*args, **kwargs)[source]

Power controls a VM from within CFME using details or collection

Raises:
  • InstanceNotFound – the instance wasn’t found when navigating
  • OptionNotAvailable – option param is not visible or enabled
set_ownership(user=None, group=None, click_cancel=False, click_reset=False)[source]

Set instance ownership

TODO: collapse this back to common.vm after both subclasses converted to widgetastic :param user: username for ownership :type user: str :param group: groupname for ownership :type group: str :param click_cancel: Whether to cancel form submission :type click_cancel: bool :param click_reset: Whether to reset form after filling

unset_ownership()[source]

Remove user ownership and return group to EvmGroup-Administrator

update(values, cancel=False, reset=False)[source]

Update cloud instance

Parameters:
  • values – Dictionary of form key/value pairs
  • cancel – Boolean, cancel the form submission
  • reset – Boolean, reset form after fill - returns immediately after reset

Note

The edit form contains a ‘Reset’ button - if this is c

wait_for_instance_state_change(desired_state, timeout=900)[source]

Wait for an instance to come to desired state.

This function waits just the needed amount of time thanks to wait_for.

Parameters:
  • desired_state – A string or list of strings indicating desired state
  • timeout – Specify amount of time (in seconds) to wait until TimedOutError is raised
class cfme.cloud.instance.InstanceAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The accordion on the instances page

images

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

images_by_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

instances

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

instances_by_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

The collection page for instances

adv_search_clear
entities
is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the details screen for an instance

access

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceProviderAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView

adv_search_clear
entities
instances_by_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceTimelinesView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.instance.CloudInstanceView, widgetastic_manageiq.TimelinesView

is_displayed
class cfme.cloud.instance.ManagePolicies(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ManagePoliciesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.PolicySimulation(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PolicySimulationView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.Provision(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvisionView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.SetOwnership(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SetOwnershipView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.SetRetirement(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RetirementView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.instance.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
cfme.cloud.provider package
Submodules
cfme.cloud.provider.azure module
class cfme.cloud.provider.azure.AzureEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

represents default Azure endpoint (Add/Edit dialogs)

view_value_mapping
class cfme.cloud.provider.azure.AzureEndpointForm(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider.DefaultEndpointForm

represents default Azure endpoint form in UI (Add/Edit dialogs)

class cfme.cloud.provider.azure.AzureProvider(name=None, endpoints=None, zone=None, key=None, region=None, tenant_id=None, subscription_id=None, appliance=None)[source]

Bases: cfme.cloud.provider.CloudProvider

BaseProvider->CloudProvider->AzureProvider class. represents CFME provider and operations available in UI

db_types = ['Azure::CloudManager']
deployment_helper(deploy_args)[source]

Used in utils.virtual_machines

static discover_dict(credential)[source]

Returns the discovery credentials dictionary

discover_name = 'Azure'
endpoints_form

alias of AzureEndpointForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]
mgmt_class = <Mock name='mock.AzureSystem' id='139657633525840'>
type_name = 'azure'
view_value_mapping

Maps values to view attrs

cfme.cloud.provider.ec2 module
class cfme.cloud.provider.ec2.EC2Endpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

represents default Amazon endpoint (Add/Edit dialogs)

view_value_mapping
class cfme.cloud.provider.ec2.EC2EndpointForm(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider.DefaultEndpointForm

represents default Amazon endpoint form in UI (Add/Edit dialogs)

class cfme.cloud.provider.ec2.EC2Provider(name=None, endpoints=None, zone=None, key=None, region=None, region_name=None, appliance=None)[source]

Bases: cfme.cloud.provider.CloudProvider

BaseProvider->CloudProvider->EC2Provider class. represents CFME provider and operations available in UI

db_types = ['Amazon::CloudManager']
static discover_dict(credential)[source]

Returns the discovery credentials dictionary

discover_name = 'Amazon EC2'
endpoints_form

alias of EC2EndpointForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]

Returns the EC” object from configuration

mgmt_class = <Mock name='mock.EC2System' id='139657603070608'>
type_name = 'ec2'
view_value_mapping

Maps values to view attrs

cfme.cloud.provider.gce module
class cfme.cloud.provider.gce.GCEEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

represents default GCE endpoint (Add/Edit dialogs)

credential_class

alias of ServiceAccountCredential

view_value_mapping
class cfme.cloud.provider.gce.GCEEndpointForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents default GCE endpoint form in UI (Add/Edit dialogs)

service_account

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

validate

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.provider.gce.GCEProvider(name=None, project=None, zone=None, region=None, region_name=None, endpoints=None, key=None, appliance=None)[source]

Bases: cfme.cloud.provider.CloudProvider

BaseProvider->CloudProvider->GCEProvider class. represents CFME provider and operations available in UI

db_types = ['Google::CloudManager']
endpoints_form

alias of GCEEndpointForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]
classmethod get_credentials(credential_dict, cred_type=None)[source]

Processes a credential dictionary into a credential object.

Parameters:
  • credential_dict – A credential dictionary.
  • cred_type – Type of credential (None, token, ssh, amqp, ...)
Returns:

A cfme.base.credential.ServiceAccountCredential instance.
mgmt_class = <Mock name='mock.GoogleCloudSystem' id='139657634044240'>
type_name = 'gce'
view_value_mapping
cfme.cloud.provider.openstack module
class cfme.cloud.provider.openstack.OpenStackProvider(name=None, endpoints=None, zone=None, key=None, hostname=None, ip_address=None, api_port=None, sec_protocol=None, amqp_sec_protocol=None, tenant_mapping=None, infra_provider=None, appliance=None)[source]

Bases: cfme.cloud.provider.CloudProvider

BaseProvider->CloudProvider->OpenStackProvider class. represents CFME provider and operations available in UI

create(*args, **kwargs)[source]
db_types = ['Openstack::CloudManager']
deployment_helper(deploy_args)[source]

Used in utils.virtual_machines

endpoints_form

alias of OpenStackInfraEndpointForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]
get_console_connection_status()[source]
get_console_ctrl_alt_del_btn()[source]
get_remote_console_canvas()[source]
mgmt_class = <Mock name='mock.OpenstackSystem' id='139657646813968'>
type_name = 'openstack'
view_value_mapping
Module contents

A model of a Cloud Provider in CFME

class cfme.cloud.provider.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudProvidersView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.cloud.provider.CloudProvider(name=None, endpoints=None, zone=None, key=None, appliance=None)[source]

Bases: utils.pretty.Pretty, cfme.common.provider.CloudInfraProvider

Abstract model of a cloud provider in cfme. See EC2Provider or OpenStackProvider.

Parameters:
  • name – Name of the provider.
  • endpoints – one or several provider endpoints like DefaultEndpoint. it should be either dict
  • format dict{endpoint.name, endpoint, endpoint_n.name, endpoint_n}, list of endpoints or (in) –
  • one endpoint (mere) –
  • key – The CFME key of the provider in the yaml.

Usage:

credentials = Credential(principal='bad', secret='reallybad')
endpoint = DefaultEndpoint(hostname='some_host', region='us-west', credentials=credentials)
myprov = VMwareProvider(name='foo',
                     endpoints=endpoint)
myprov.create()
STATS_TO_MATCH = ['num_template', 'num_vm']
as_fill_value()[source]
category = 'cloud'
db_types = ['CloudManager']
static discover_dict(credential)[source]

Returns the discovery credentials dictionary, needs overiding

page_name = 'clouds'
pretty_attrs = ['name', 'credentials', 'zone', 'key']
provider_types = {}
string_name = 'Cloud'
template_name = 'Images'
templates_destination_name = 'Images'
view_value_mapping

Maps values to view attrs

vm_name = 'Instances'
class cfme.cloud.provider.CloudProviderTimelinesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.TimelinesView, cfme.base.login.BaseLoggedInPage

is_displayed
class cfme.cloud.provider.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudProviderDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.Discover(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudProvidersDiscoverView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudProviderEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.EditFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudProviderEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvidersEditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.EditTagsFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvidersEditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.Images(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.provider.Instances(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.provider.ManagePolicies(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvidersManagePoliciesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.ManagePoliciesFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvidersManagePoliciesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.New(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudProviderAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.provider.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudProviderTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.cloud.provider.discover(credential, discover_cls, cancel=False)[source]

Discover cloud providers. Note: only starts discovery, doesn’t wait for it to finish.

Parameters:
  • credential (cfme.base.credential.Credential) – Discovery credentials.
  • cancel (boolean) – Whether to cancel out of the discover UI.
  • discover_cls – class of the discovery item
cfme.cloud.provider.get_all_providers()[source]

Returns list of all providers

cfme.cloud.provider.wait_for_a_provider()[source]
Submodules
cfme.cloud.availability_zone module

A page functions for Availability Zone

class cfme.cloud.availability_zone.AvailabilityZone(name, provider, appliance=None)[source]

Bases: utils.appliance.Navigatable

class cfme.cloud.availability_zone.AvailabilityZoneAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AvailabilityZoneAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.availability_zone.AvailabilityZoneAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.availability_zone.AvailabilityZoneView

Collect the view components into a single view

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.availability_zone.AvailabilityZoneDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AvailabilityZoneDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.availability_zone.AvailabilityZoneDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

View containing the accordion widgets for the left side pane on details view

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.availability_zone.AvailabilityZoneDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

View containing the widgets for the main content pane on the details page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.availability_zone.AvailabilityZoneDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

View containing the toolbar widgets

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.availability_zone.AvailabilityZoneDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.availability_zone.AvailabilityZoneView

Collect the view components into a single view

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.availability_zone.AvailabilityZoneEditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AvailabilityZoneEditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.availability_zone.AvailabilityZoneEditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.availability_zone.AvailabilityZoneView

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.availability_zone.AvailabilityZoneEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

View containing the widgets for the main content pane

search

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.availability_zone.AvailabilityZoneTimelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudAvailabilityZoneTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.availability_zone.AvailabilityZoneToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

View containing the toolbar widgets

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.availability_zone.AvailabilityZoneView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Bare bones base view for page header matching

in_availability_zones
class cfme.cloud.availability_zone.CloudAvailabilityZoneTimelinesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.TimelinesView, cfme.cloud.availability_zone.AvailabilityZoneView

is_displayed
cfme.cloud.flavor module

Page functions for Flavor pages

class cfme.cloud.flavor.Flavor(name, provider, appliance=None)[source]

Bases: utils.appliance.Navigatable

Flavor class to support navigation

class cfme.cloud.flavor.FlavorAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of FlavorAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.flavor.FlavorAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.flavor.FlavorView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.flavor.FlavorDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.flavor.FlavorDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.flavor.FlavorDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.flavor.FlavorDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.flavor.FlavorDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.flavor.FlavorView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.flavor.FlavorEditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.flavor.FlavorEditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.flavor.FlavorView

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.flavor.FlavorEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

search

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.flavor.FlavorToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.flavor.FlavorView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

in_availability_zones
cfme.cloud.keypairs module
class cfme.cloud.keypairs.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of KeyPairAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Raises DropdownItemDisabled from widgetastic_patternfly if no RHOS provider present

class cfme.cloud.keypairs.CloudKeyPairs(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of KeyPairAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.keypairs.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of KeyPairDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.cloud.keypairs.KeyPair(name, provider, public_key=None, appliance=None, collection=None)[source]

Bases: utils.appliance.Navigatable

Automate Model page of KeyPairs

Parameters:name – Name of Keypairs.
add_tag(tag, **kwargs)[source]

Tags the Keypair by given tag

delete(cancel=False, wait=False)[source]
exists
remove_tag(tag, **kwargs)[source]

Untag the Keypair by given tag

class cfme.cloud.keypairs.KeyPairAddEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.keypairs.KeyPairAddForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

public_key

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.keypairs.KeyPairAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.keypairs.KeyPairView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.cloud.keypairs.KeyPairAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.keypairs.KeyPairView

entities
is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.keypairs.KeyPairCollection(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

Collection object for the :py:class: cfme.cloud.KeyPair.

create(name, provider, public_key=None, cancel=False)[source]

Create new keyPair.

Parameters:
  • name (str) – name of the KeyPair
  • public_key (str) – RSA Key if present
  • provider (str) – Cloud Provider
  • cancel (boolean) – Cancel Keypair creation
instantiate(name, provider, public_key=None, appliance=None)[source]
class cfme.cloud.keypairs.KeyPairDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.keypairs.KeyPairDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.keypairs.KeyPairDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.keypairs.KeyPairDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.keypairs.KeyPairView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.keypairs.KeyPairToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.keypairs.KeyPairView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Base view for header and nav checking, navigatable views should inherit this

in_keypair
cfme.cloud.security_group module

Page functions for Security Group page

var list_page:A cfme.web_ui.Region object describing elements on the list page.
var details_page:
 A cfme.web_ui.Region object describing elements on the detail page.
cfme.cloud.stack module
class cfme.cloud.stack.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of StackAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]

Reset the view

step(*args, **kwargs)[source]

Go to the all page

class cfme.cloud.stack.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of StackDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Go to the details page

class cfme.cloud.stack.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of StackEditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Go to the edit tags screen

class cfme.cloud.stack.RelationshipOutputs(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of StackOutputsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.stack.RelationshipParameters(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of StackParametersView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.stack.RelationshipResources(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of StackResourcesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.stack.RelationshipsSecurityGroups(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of StackSecurityGroupsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.cloud.stack.Stack(name, provider, quad_name=None, collection=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

delete()[source]

Delete the stack from detail view

edit_tags(tag, value)[source]

Edit the tags of a particular stack

exists
get_tags()[source]
pretty_attrs = ['name']
retire_stack(wait=True)[source]
wait_for_exists()[source]

Wait for the row to show up

class cfme.cloud.stack.StackAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.stack.StackView

The main list page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackCollection(appliance=None)[source]

Bases: utils.appliance.Navigatable

Collection class for cfme.cloud.stack.Stack

delete(*stacks)[source]
instantiate(name, provider, quad_name=None)[source]
class cfme.cloud.stack.StackDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The accordion on the details page

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entties on the detail page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the stacks detail page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.stack.StackView

The detail page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackEditTagEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities on the edit tags page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackEditTagsForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The form on the edit tags page

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackEditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.stack.StackView

The edit tags page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

class cfme.cloud.stack.StackEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entties on the main list page

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

search

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackOutputsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities of the resources page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

outputs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackOutputsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.stack.StackView

The resources page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackParametersEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities of the resources page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

parameters

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackParametersView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.stack.StackView

The resources page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackResourcesEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities of the resources page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

resources

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackResourcesView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.stack.StackView

The resources page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackSecurityGroupsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities of the resources page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

security_groups

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackSecurityGroupsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.stack.StackView

The resources page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackSubpageToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the sub pages, like resources and security groups

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

show_summary

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the stacks page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.stack.StackView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

The base view for header and nav checking

in_stacks

Determine if the Stacks page is currently open

cfme.cloud.tenant module

Page functions for Tenant pages

var list_page:A cfme.web_ui.Region object describing elements on the list page.
var details_page:
 A cfme.web_ui.Region object describing elements on the detail page.
class cfme.cloud.tenant.Tenant(name, provider, collection=None)[source]

Bases: utils.appliance.Navigatable

Tenant Class

delete(wait=True)[source]

Delete the tenant

exists
update(updates)[source]
wait_for_appear(timeout=600)[source]
wait_for_disappear(timeout=300)[source]
class cfme.cloud.tenant.TenantAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TenantAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Navigate to the Add page

class cfme.cloud.tenant.TenantAddForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The form on the Add page

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cloud_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
class cfme.cloud.tenant.TenantAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.tenant.TenantView

The add page for tenants

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

class cfme.cloud.tenant.TenantAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TenantAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]

Reset the view

step(*args, **kwargs)[source]

Go to the All page

class cfme.cloud.tenant.TenantAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.tenant.TenantView

The all tenants page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

This is page currently being displayed

paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantCollection(appliance=None)[source]

Bases: utils.appliance.Navigatable

Collection object for the cfme.cloud.tenant.Tenant.

create(name, provider, appliance=None, wait=True)[source]

Add a cloud Tenant from the UI and return the Tenant object

delete(*tenants)[source]

Delete one or more Tenants from the list of the Tenants

Parameters:of the cfme.cloud.tenant.Tenant objects (list) –
instantiate(name, provider)[source]
class cfme.cloud.tenant.TenantDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TenantDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]

Reset the view

step(*args, **kwargs)[source]

Navigate to the details page

class cfme.cloud.tenant.TenantDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The accordion on the details page

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities on the details page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

quotas

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the tenant details page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.tenant.TenantView

The details page for a tenant

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TenantEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Navigate to the edit page

class cfme.cloud.tenant.TenantEditEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities on the add/edit page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantEditForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The form on the Edit page

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantEditTagEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities on the edit tags page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantEditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TenantEditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Navigate to the edit tags page

class cfme.cloud.tenant.TenantEditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.tenant.TenantView

The edit tags page

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.cloud.tenant.TenantView

The edit page for tenants

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

class cfme.cloud.tenant.TenantEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities on the main list page

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

search

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the tenants page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.tenant.TenantView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

A base view for all the Tenant pages

in_tenants

Determine if the Tenants page is currently open

Module contents
cfme.common package
Submodules
cfme.common.host_views module
class cfme.common.host_views.ComputeInfrastructureHostsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Common parts for host views.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_compute_infrastructure_hosts
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.HostFormView

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

host_platform

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.common.host_views.HostDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents Details page.

authentication_status

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

compliance

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

openstack_hardware

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

security

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents host toolbar and its controls.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

custom_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.ComputeInfrastructureHostsView

Main Host details page.

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostDiscoverView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.ComputeInfrastructureHostsView

Discover View from Compute/Infrastructure/Hosts page.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

esx

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

from_ip1

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

from_ip2

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

from_ip3

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

from_ip4

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ipmi

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
start_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

to_ip4

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostDriftAnalysis(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.ComputeInfrastructureHostsView

apply_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

drift_analysis

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

drift_sections

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostDriftHistory(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.ComputeInfrastructureHostsView

analyze_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

history_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.common.host_views.HostEditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Host’s Edit Tags view.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

chosen_tags

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag_category

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.HostFormView

View for editing a single host

change_stored_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostEntitiesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents the view with different items like hosts.

entity_class
cfme.common.host_views.HostEntity()[source]

Temporary wrapper for Host Entity during transition to JS based Entity

class cfme.common.host_views.HostFormView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.ComputeInfrastructureHostsView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

custom_ident

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

endpoints

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hostname

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ipmi_address

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

mac_address

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostListEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseListEntity

class cfme.common.host_views.HostManagePoliciesView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Host’s Manage Policies view.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policies

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostQuadIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseQuadIconEntity

data
class cfme.common.host_views.HostSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar. It usually contains navigation, filters, etc.

class cfme.common.host_views.HostTileIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseTileIconEntity

quad_icon

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostTimelinesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.TimelinesView, cfme.common.host_views.ComputeInfrastructureHostsView

Represents a Host Timelines page.

is_displayed
class cfme.common.host_views.HostsEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.HostEditView

View when editing multiple hosts Restricted to endpoints section of the form Title changes Must select host before validation

is_displayed
validation_host

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents hosts toolbar and its controls.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.HostsView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.ComputeInfrastructureHostsView

entities
is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.host_views.NonJSHostEntity(parent, name, logger=None)[source]

Bases: widgetastic_manageiq.NonJSBaseEntity

list_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

quad_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tile_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.common.provider module
class cfme.common.provider.BaseProvider(*args, **kwargs)[source]

Bases: cfme.common.Taggable, utils.update.Updateable, cfme.common.SummaryMixin, utils.appliance.Navigatable

STATS_TO_MATCH = []
add_provider_button = None
classmethod clear_providers()[source]

Clear all providers of given class on the appliance

create(cancel=False, validate_credentials=True, check_existing=False, validate_inventory=False)[source]

Creates a provider in the UI

Parameters:
  • cancel (boolean) – Whether to cancel out of the creation. The cancel is done after all the information present in the Provider has been filled in the UI.
  • validate_credentials (boolean) – Whether to validate credentials - if True and the credentials are invalid, an error will be raised.
  • check_existing (boolean) – Check if this provider already exists, skip if it does
  • validate_inventory (boolean) – Whether or not to block until the provider stats in CFME match the stats gleaned from the backend management system (default: True)
Returns:

True if it was created, False if it already existed
create_rest()[source]
data
db_types = ['Providers']
default_endpoint
delete(cancel=True)[source]

Deletes a provider from CFME

Parameters:cancel – Whether to cancel the deletion, defaults to True
delete_if_exists(*args, **kwargs)[source]

Combines .exists and .delete() as a shortcut for request.addfinalizer

Returns: True if provider existed and delete was initiated, False otherwise

deployment_helper(deploy_args)[source]

Used in utils.virtual_machines and usually overidden

detail_page_suffix = ''
edit_page_suffix = ''
exists

Returns True if a provider of the same name exists on the appliance

get_all_host_ids()[source]

Returns an integer list of host ID’s via the Rest API

get_all_provider_ids()[source]

Returns an integer list of provider ID’s via the REST API

get_all_template_details()[source]

Returns a dictionary mapping template ids to their name, type, and guid

get_all_template_ids()[source]

Returns an integer list of template ID’s via the Rest API

get_all_vm_ids()[source]

Returns an integer list of vm ID’s via the REST API

get_console_connection_status()[source]
get_console_ctrl_alt_del_btn()[source]
get_console_fullscreen_btn()[source]
classmethod get_credentials(credential_dict, cred_type=None)[source]

Processes a credential dictionary into a credential object.

Parameters:
  • credential_dict – A credential dictionary.
  • cred_type – Type of credential (None, token, ssh, amqp, ...)
Returns:

A cfme.base.credential.Credential instance.
classmethod get_credentials_from_config(credential_config_name, cred_type=None)[source]

Retrieves the credential by its name from the credentials yaml.

Parameters:
  • credential_config_name – The name of the credential in the credentials yaml.
  • cred_type – Type of credential (None, token, ssh, amqp, ...)
Returns:

A cfme.base.credential.Credential instance.
get_detail(*ident, **kwargs)[source]

Gets details from the details infoblock

The function first ensures that we are on the detail page for the specific provider.

Parameters:*ident – An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”
Keywords:
use_icon: Whether to use icon matching

Returns: A string representing the contents of the InfoBlock’s value.

get_mgmt_system()[source]

Returns the mgmt_system using the utils.providers.get_mgmt() method.

get_provider_details(provider_id)[source]

Returns the name, and type associated with the provider_id

get_provider_id(provider_name)[source]

” Return the ID associated with the specified provider name

get_remote_console_canvas()[source]
get_template_details(template_id)[source]

Returns the name, type, and guid associated with the template_id

get_template_guids(template_dict)[source]

Returns a list of tuples. The inner tuples are formated so that each guid is in index 0, and its provider’s name is in index 1. Expects a dictionary mapping a provider to its templates

get_vm_details(vm_id)[source]

Returns the name, type, vendor, host_id, and power_state associated with the vm_id.

get_vm_id(vm_name)[source]

Return the ID associated with the specified VM name

get_vm_ids(vm_names)[source]

Returns a dictionary mapping each VM name to it’s id

get_yaml_data()[source]

Returns yaml data for this provider.

is_refreshed(*args, **kwargs)
last_refresh_date(*args, **kwargs)
load_details(refresh=False)[source]

To be compatible with the Taggable and PolicyProfileAssignable mixins.

mgmt
one_of(*classes)[source]

Returns true if provider is an instance of any of the classes or sublasses there of

page_name = ''
classmethod process_credential_yaml_key(cred_yaml_key, cred_type=None)[source]

Function that detects if it needs to look up credentials in the credential yaml and acts as expected.

If you pass a dictionary, it assumes it does not need to look up in the credentials yaml file. If anything else is passed, it continues with looking up the credentials in the yaml file.

Parameters:cred_yaml_key – Either a string pointing to the credentials.yaml or a dictionary which is considered as the credentials.
Returns:cfme.base.credential.Credential instance
properties_form
quad_name = None
refresh_provider_relationships(*args, **kwargs)
refresh_provider_relationships_ui = None
refresh_text = ''
save_button = None
setup(rest=False)[source]

Sets up the provider robustly

string_name = ''
type
update(updates, cancel=False, validate_credentials=True)[source]

Updates a provider in the UI. Better to use utils.update.update context manager than call this directly.

Parameters:
  • updates (dict) – fields that are changing.
  • cancel (boolean) – whether to cancel out of the update.
  • validate_credentials (boolean) – whether credentials have to be validated
validate()[source]
validate_stats(ui=False)[source]

Validates that the detail page matches the Providers information.

This method logs into the provider using the mgmt_system interface and collects a set of statistics to be matched against the UI. The details page is then refreshed continuously until the matching of all items is complete. A error will be raised if the match is not complete within a certain defined time period.

version
wait_for_delete()[source]
class cfme.common.provider.CANDUEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

credential_class

alias of CANDUCredential

name = 'candu'
view_value_mapping
class cfme.common.provider.CloudInfraProvider(*args, **kwargs)[source]

Bases: cfme.common.provider.BaseProvider, cfme.common.PolicyProfileAssignable

db_types = ['CloudManager', 'InfraManager']
detail_page_suffix = 'provider'
edit_page_suffix = 'provider_edit'
get_assigned_policy_profiles()[source]

Return a set of Policy Profiles which are available and assigned.

Returns: set of str of Policy Profile names

get_unassigned_policy_profiles()[source]

Return a set of Policy Profiles which are available but not assigned.

Returns: set of str of Policy Profile names

hostname
ip_address
load_all_provider_images()[source]
load_all_provider_instances()[source]
load_all_provider_templates()[source]

Loads the list of images that are available under the provider.

If it could click through the link in infoblock, returns True. If it sees that the number of images is 0, it returns False.

load_all_provider_vms()[source]

Loads the list of instances that are running under the provider.

If it could click through the link in infoblock, returns True. If it sees that the number of instances is 0, it returns False.

num_template(*args, **kwargs)
num_template_ui = None
num_vm(*args, **kwargs)
num_vm_ui = None
refresh_text = 'Refresh Relationships and Power States'
template_name = ''
vm_name = ''
class cfme.common.provider.DefaultEndpoint(**kwargs)[source]

Bases: object

credential_class

alias of Credential

name = 'default'
view_value_mapping
class cfme.common.provider.DefaultEndpointForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

change_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

confirm_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hostname

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

validate

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider.EventsEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

credential_class

alias of EventsCredential

name = 'events'
view_value_mapping
class cfme.common.provider.SSHEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

credential_class

alias of SSHCredential

name = 'rsa_keypair'
view_value_mapping
cfme.common.provider.all_types()[source]
cfme.common.provider.base_types()[source]
cfme.common.provider.cleanup_vm(vm_name, provider)[source]
cfme.common.provider.provider_types(category)[source]
cfme.common.provider_views module
class cfme.common.provider_views.BeforeFillMixin[source]

Bases: object

this mixin is used to activate appropriate tab before filling this tab

before_fill()[source]
class cfme.common.provider_views.CloudProviderAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderAddView

represents Cloud Provider Add View

api_version

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

infra_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
project_id

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

prov_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

region

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

subscription

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tenant_id

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tenant_mapping

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.CloudProviderDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderDetailsView

Cloud Details page

is_displayed
class cfme.common.provider_views.CloudProviderEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderEditView

represents Cloud Provider Edit View

is_displayed
class cfme.common.provider_views.CloudProvidersDiscoverView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Discover View from Infrastructure Providers page

Amazon = None
Azure = None
cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

discover_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

fields

Conditional switchable view implementation.

This widget proxy is useful when you have a form whose parts displayed depend on certain conditions. Eg. when you select certain value from a dropdown, one form is displayed next, when other value is selected, a different form is displayed next. This widget proxy is designed to register those multiple views and then upon accessing decide which view to use based on the registration conditions.

The resulting widget proxy acts similarly like a nested view (if you use view of course).

Example

class SomeForm(View):
    foo = Input('...')
    action_type = Select(name='action_type')

    action_form = ConditionalSwitchableView(reference='action_type')

    # Simple value matching. If Action type 1 is selected in the select, use this view.
    # And if the action_type value does not get matched, use this view as default
    @action_form.register('Action type 1', default=True)
    class ActionType1Form(View):
        widget = Widget()

    # You can use a callable to declare the widget values to compare
    @action_form.register(lambda action_type: action_type == 'Action type 2')
    class ActionType2Form(View):
        widget = Widget()

    # With callable, you can use values from multiple widgets
    @action_form.register(
        lambda action_type, foo: action_type == 'Action type 2' and foo == 2)
    class ActionType2Form(View):
        widget = Widget()

You can see it gives you the flexibility of decision based on the values in the view.

Parameters:
  • reference – For using non-callable conditions, this must be specified. Specifies the name of the widget whose value will be used for comparing non-callable conditions. Supports going across objects using ..
  • ignore_bad_reference – If this is enabled, then when the widget representing the reference is not displayed or otherwise broken, it will then use the default view.
is_displayed
start

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.CloudProvidersView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProvidersView

represents Main view displaying all Cloud providers

entities
is_displayed
class cfme.common.provider_views.ContainersProviderAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderAddView

represents Containers Provider Add View

is_displayed
prov_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ContainersProviderEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderEditView

represents Containers Provider Edit View

is_displayed
class cfme.common.provider_views.ContainersProvidersView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProvidersView

represents Main view displaying all Containers providers

entities
is_displayed
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.InfraProviderAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderAddView

api_version

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.common.provider_views.InfraProviderDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderDetailsView

Infra Details page

is_displayed
class cfme.common.provider_views.InfraProviderEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderEditView

represents Infra Provider Edit View

is_displayed
class cfme.common.provider_views.InfraProvidersDiscoverView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Discover View from Infrastructure Providers page

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

from_ip1

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

from_ip2

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

from_ip3

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

from_ip4

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
rhevm

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

scvmm

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

start

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

to_ip4

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vmware

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.InfraProvidersView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProvidersView

represents Main view displaying all Infra providers

entities
is_displayed
class cfme.common.provider_views.NodesToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents nodes toolbar and its controls (exists for Infra OpenStack provider)

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProviderAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

represents Provider Add View

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

endpoints

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
keystone_v3_domain_id

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

prov_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

zone

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProviderDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents provider toolbar and its controls

authentication

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProviderDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

main Details page

ProviderDetailsDashboardView = None
ProviderDetailsSummaryView = None
breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

contents

Conditional switchable view implementation.

This widget proxy is useful when you have a form whose parts displayed depend on certain conditions. Eg. when you select certain value from a dropdown, one form is displayed next, when other value is selected, a different form is displayed next. This widget proxy is designed to register those multiple views and then upon accessing decide which view to use based on the registration conditions.

The resulting widget proxy acts similarly like a nested view (if you use view of course).

Example

class SomeForm(View):
    foo = Input('...')
    action_type = Select(name='action_type')

    action_form = ConditionalSwitchableView(reference='action_type')

    # Simple value matching. If Action type 1 is selected in the select, use this view.
    # And if the action_type value does not get matched, use this view as default
    @action_form.register('Action type 1', default=True)
    class ActionType1Form(View):
        widget = Widget()

    # You can use a callable to declare the widget values to compare
    @action_form.register(lambda action_type: action_type == 'Action type 2')
    class ActionType2Form(View):
        widget = Widget()

    # With callable, you can use values from multiple widgets
    @action_form.register(
        lambda action_type, foo: action_type == 'Action type 2' and foo == 2)
    class ActionType2Form(View):
        widget = Widget()

You can see it gives you the flexibility of decision based on the values in the view.

Parameters:
  • reference – For using non-callable conditions, this must be specified. Specifies the name of the widget whose value will be used for comparing non-callable conditions. Supports going across objects using ..
  • ignore_bad_reference – If this is enabled, then when the widget representing the reference is not displayed or otherwise broken, it will then use the default view.
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProviderEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProviderAddView

represents Provider Edit View

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
prov_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vnc_end_port

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vnc_start_port

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProviderEntitiesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

represents child class of Entities view for Provider entities

entity_class
class cfme.common.provider_views.ProviderNodesView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

represents main Nodes view (exists for Infra OpenStack provider)

entities
is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProviderSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents left side bar. it usually contains navigation, filters, etc

class cfme.common.provider_views.ProviderTimelinesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.TimelinesView, cfme.base.login.BaseLoggedInPage

represents Timelines page

is_displayed
class cfme.common.provider_views.ProviderToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents provider toolbar and its controls

authentication

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProvidersEditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Provider’s Edit Tags view

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

chosen_tags

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag_category

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProvidersManagePoliciesView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Provider’s Manage Policies view

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policies

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.provider_views.ProvidersView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

represents Main view displaying all providers

entities
is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.common.vm module

Module containing classes with common behaviour for both VMs and Instances of all types.

class cfme.common.vm.BaseVM(name, provider, template_name=None, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.update.Updateable, cfme.common.PolicyProfileAssignable, cfme.common.Taggable, cfme.common.SummaryMixin, utils.appliance.Navigatable

Base VM and Template class that holds the largest common functionality between VMs, instances, templates and images.

In order to inherit these, you have to implement the on_details method.

ALL_LIST_LOCATION = None
QUADICON_TYPE = 'vm'
REMOVE_SELECTED = {'5.6.2.2': 'Remove selected items from the VMDB', '5.6': 'Remove selected items', '5.7': 'Remove selected items'}
REMOVE_SINGLE = {'5.6.2.2': 'Remove from the VMDB', '5.6': 'Remove Virtual Machine', '5.7': 'Remove Virtual Machine'}
RETIRE_DATE_FMT = {Version('lowest'): '%m/%d/%y', '5.7': '%m/%d/%y %H:%M UTC'}
TO_OPEN_EDIT = None
check_compliance(timeout=240)[source]

Initiates compliance check and waits for it to finish.

compliance_status

Returns the title of the compliance infoblock. The title contains datetime so it can be compared.

Returns:NoneType if no title is present (no compliance checks before), otherwise str
compliant

Check if the VM is compliant

Returns:NoneType if the VM was never verified, otherwise bool
console_handle

The basic algorithm for getting the consoles window handle is to get the appliances window handle and then iterate through the window_handles till we find one that is not the appliances window handle. Once we find this check that it has a canvas widget with a specific ID

delete(cancel=False, from_details=False)[source]

Deletes the VM/Instance from the VMDB.

Parameters:
  • cancel – Whether to cancel the action in the alert.
  • from_details – Whether to use the details view or list view.
edit_form = <cfme.web_ui.Form fields=[('custom_ident', <cfme.web_ui.Input _names=('custom_1',), _use_id=False>), ('description_tarea', "//textarea[@id='description']"), ('parent_sel', {Version('lowest'): Select("//select[@name='chosen_parent']", multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='chosen_parent']", none=None, multi=False, exact=False>}), ('child_sel', Select("//select[@id='kids_chosen']", multi=True)), ('vm_sel', Select("//select[@id='choices_chosen']", multi=True)), ('add_btn', "//img[@alt='Move selected VMs to left']"), ('remove_btn', "//img[@alt='Move selected VMs to right']"), ('remove_all_btn', "//img[@alt='Move all VMs to right']")]>
exists

Checks presence of the quadicon in the CFME.

classmethod factory(vm_name, provider, template_name=None, template=False)[source]

Factory class method that determines the correct subclass for given provider.

For reference how does that work, refer to the entrypoints in the setup.py

Parameters:
  • vm_name – Name of the VM/Instance as it appears in the UI
  • provider – The provider object (not the string!)
  • template_name – Source template name. Useful when the VM/Instance does not exist and you want to create it.
  • template – Whether the generated object class should be VM/Instance or a template class.
find_quadicon(from_any_provider=False, use_search=True)[source]

Find and return a quadicon belonging to a specific vm

Parameters:from_any_provider – Whether to look for it anywhere (root of the tree). Useful when looking up archived or orphaned VMs

Returns: entity of appropriate type Raises: VmOrInstanceNotFound

get_detail(properties=None, icon_href=False)[source]

Gets details from the details infoblock

The function first ensures that we are on the detail page for the specific VM/Instance.

Parameters:properties – An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”
Returns:A string representing the contents of the InfoBlock’s value.
classmethod get_first_vm_title(do_not_navigate=False, provider=None)[source]

Get the title of first VM/Instance.

ip_address

Fetches IP Address of VM

is_retired

“Check retirement status of vm

is_vm
last_analysed

Returns the contents of the Last Analysed field in summary

load_details(refresh=False)[source]

Navigates to an VM’s details page.

Parameters:

refresh – Refreshes the VM page if already there
Raises:

VmOrInstanceNotFound

When unable to find the VM passed
open_console(console='VM Console', invokes_alert=False, cancel=False)[source]

Initiates the opening of one of the console types supported by the Access button. Presently we only support VM Console, which is the HTML5 Console. In case of VMware provider it could be VMRC, VNC/HTML5, WebMKS, but we only support VNC/HTML5. Possible values for ‘console’ could be ‘VM Console’ and ‘Web Console’, but Web Console is not supported as well.

Parameters:
  • console – one of the supported console types given by the Access button.
  • invokes_alert – If the particular console will invoke a CFME popup/alert setting this to true will handle this.
  • cancel – Allows one to cancel the operation if the popup/alert occurs.
open_details(properties=None)[source]

Clicks on details infoblock

open_edit()[source]

Loads up the edit page of the object.

open_timelines()[source]

Navigates to an VM’s timeline page.

Returns:TimelinesView object
paged_table
pretty_attrs = ['name', 'provider', 'template_name']
quadicon_type
rediscover()[source]

Deletes the VM from the provider and lets it discover again

rediscover_if_analysis_data_present()[source]

Rediscovers the object if it has some analysis data present.

Returns:Boolean if the rediscovery happened.
refresh_relationships(from_details=False, cancel=False, from_any_provider=False)[source]

Executes a refresh of relationships.

Parameters:
  • from_details – Whether or not to perform action from instance details page
  • cancel – Whether or not to cancel the refresh relationships action
retirement_date

Returns the retirement date of the selected machine, or ‘Never’

Returns:str object
set_ownership(user=None, group=None, click_cancel=False, click_reset=False)[source]

Set ownership of the VM/Instance or Template/Image

smartstate_scan(cancel=False, from_details=False)[source]

Initiates fleecing from the UI.

Parameters:
  • cancel – Whether or not to cancel the refresh relationships action
  • from_details – Whether or not to perform action from instance details page
unset_ownership()[source]

Unset ownership of the VM/Instance or Template/Image

wait_for_delete(timeout=600, load_details=True)

Wait for a VM to disappear within CFME

Parameters:timeout – time (in seconds) to wait for it to appear
wait_to_appear(timeout=600, load_details=True)[source]

Wait for a VM to appear within CFME

Parameters:
  • timeout – time (in seconds) to wait for it to appear
  • load_details – when found, should it load the vm details
wait_to_disappear(timeout=600, load_details=True)[source]

Wait for a VM to disappear within CFME

Parameters:timeout – time (in seconds) to wait for it to appear
class cfme.common.vm.Template(name, provider, template_name=None)[source]

Bases: cfme.common.vm.BaseVM, cfme.common.vm._TemplateMixin

A base class for all templates. The constructor is a bit different, it scraps template_name.

does_template_exist_on_provider()

Check if template exists on provider itself

does_vm_exist_on_provider()[source]

Check if template exists on provider itself

class cfme.common.vm.VM(name, provider, template_name=None, appliance=None)[source]

Bases: cfme.common.vm.BaseVM

TO_RETIRE = None
create_on_provider(timeout=900, find_in_cfme=False, **kwargs)[source]

Create the VM on the provider

Parameters:timeout – Number of seconds to wait for the VM to appear in CFME Will not wait at all, if set to 0 (Defaults to 900)
delete_from_provider()[source]
does_vm_exist_on_provider()[source]

Check if VM exists on provider itself

equal_drift_results(row_text, section, *indexes)[source]

Compares drift analysis results of a row specified by it’s title text

Parameters:
  • row_text – Title text of the row to compare
  • section – Accordion section where the change happened; this section will be activated
  • indexes – Indexes of results to compare starting with 0 for first row (latest result). Compares all available drifts, if left empty (default).

Note

There have to be at least 2 drift results available for this to work.

Returns:True if equal, False otherwise.
is_pwr_option_available_in_cfme(option, from_details=False)[source]

Checks to see if a power option is available on the VM

Parameters:
  • option – corresponds to option values under the power button, see EC2Instance and OpenStackInstance
  • from_details – Whether or not to perform action from instance details page
power_control_from_cfme(option, cancel=True, from_details=False)[source]

Power controls a VM from within CFME

Parameters:
  • option – corresponds to option values under the power button
  • cancel – Whether or not to cancel the power operation on confirmation
  • from_details – Whether or not to perform action from instance details page
Raises:

OptionNotAvailable – option param is not visible or enabled
power_control_from_provider()[source]
retire()[source]
retire_form = <cfme.web_ui.Form fields=[('date_retire', <cfme.web_ui.AngularCalendarInput input_name='retirement_date', click_away_element="//label[contains(normalize-space(.), 'Retirement Date')]">), ('warn', <cfme.web_ui.AngularSelect _loc="//button[@data-id='retirementWarning']", none=None, multi=False, exact=False>)]>
set_retirement_date(when, warn=None)[source]

Sets the retirement date for this Vm object.

It incorporates some magic to make it work reliably since the retirement form is not very pretty and it can’t be just “done”.

Parameters:
wait_candu_data_available(timeout=600)[source]

Waits until C&U data are available for this VM/Instance

Parameters:timeout – Timeout passed to utils.wait.wait_for()
wait_for_vm_state_change(desired_state=None, timeout=300, from_details=False, with_relationship_refresh=True, from_any_provider=False)[source]

Wait for M to come to desired state.

This function waits just the needed amount of time thanks to wait_for.

Parameters:
  • desired_state – on, off, suspended... for available states, see EC2Instance and OpenStackInstance
  • timeout – Specify amount of time (in seconds) to wait
  • from_any_provider – Archived/Orphaned vms need this
Raises:

  • TimedOutError

    When instance does not come up to desired state in specified period of time.

  • InstanceNotFound

    When unable to find the instance passed
cfme.common.vm.all_types(template=False)[source]
cfme.common.vm.base_types(template=False)[source]
cfme.common.vm.date_retire_element(fill_data)[source]

We need to call this function that will mimic clicking the calendar, picking the date and the subsequent callbacks from the server

cfme.common.vm.instance_types(category, template=False)[source]
cfme.common.vm_console module

Module containing classes with common behaviour for consoles of both VMs and Instances of all types.

class cfme.common.vm_console.VMConsole(vm, console_handle, appliance_handle)[source]

Bases: utils.pretty.Pretty

Class to manage the VM Console. Presently, only support HTML5 Console.

close_console_window()[source]

Attempt to close Console window at the end of test.

find_text_on_screen(text_to_find, current_line=False)[source]

Find particular text is present on Screen.

This function uses get_screen_text function to get string containing the text on the screen and then tries to match it against the ‘text_to_find’.

Parameters:text_to_find – This is what re.search will try to search for on screen.
Returns:If the match is found returns True else False.
get_banner()[source]

Get the text of the banner above the console screen.

get_screen(timeout=15)[source]

Retrieve the bit map from the canvas widget that represents the console screen.

Returns it as a binary string.

Implementation: The canvas tag has a method toDataURL() which one can use in javascript to obtain the canvas image base64 encoded. Examples of how to do this can be seen here:

get_screen_text()[source]

Return the text from a text console.

Uses OCR to scrape the text from the console image taken at the time of the call.

is_connected()[source]

Wait for the banner on the console to say the console is connected.

pretty_attrs = ['appliance_handle', 'browser', 'console_handle', 'name']
send_ctrl_alt_delete()[source]

Press the ctrl-alt-delete button in the console tab.

send_fullscreen()[source]

Press the fullscreen button in the console tab.

send_keys(text)[source]

Send text to the console.

switch_to_appliance()[source]

Switch focus to appliance tab/window.

switch_to_console()[source]

Switch focus to console tab/window.

wait_for_connect(timeout=30)[source]

Wait for as long as the specified/default timeout for the console to be connected.

wait_for_text(timeout=45, text_to_find='', to_disappear=False)[source]

Wait for as long as the specified/default timeout for the ‘text’ to show up on screen.

Parameters:
  • timeout – Wait Time before wait_for function times out.
  • text_to_find – value passed to find_text_on_screen function
  • to_disappear – if set to True, function will wait for text_to_find to disappear from screen.
cfme.common.vm_views module
class cfme.common.vm_views.BasicProvisionFormView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

catalog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

customize

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

environment

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hardware

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

network

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

purpose

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

request

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

schedule

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.vm_views.EditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Edit vms/instance tags page The title actually as Instance|VM.VM_TYPE string in it, otherwise the same

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.common.vm_views.EditView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Edit vms/instance page The title actually as Instance|VM.VM_TYPE string in it, otherwise the same

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.common.vm_views.InstanceEntity()[source]

Temporary wrapper for Instance Entity during transition to JS based Entity

class cfme.common.vm_views.InstanceListEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseListEntity

Provider child of List entity

class cfme.common.vm_views.InstanceQuadIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseQuadIconEntity

Provider child of Quad Icon entity

data
class cfme.common.vm_views.InstanceTileIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseTileIconEntity

Provider child of Tile Icon entity

quad_icon

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.vm_views.ManagePoliciesView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Manage policies page

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.common.vm_views.ManagementEngineView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Edit management engine relationship page The title actually as Instance|VM.VM_TYPE string in it, otherwise the same

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.common.vm_views.NonJSInstanceEntity(parent, name, logger=None)[source]

Bases: widgetastic_manageiq.NonJSBaseEntity

Provider child of Proxy entity

list_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

quad_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tile_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.vm_views.PolicySimulationView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Policy Simulation page for vms/instances

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.common.vm_views.ProvisionView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

The provisioning view, with nested ProvisioningForm as form attribute. Handles template selection before Provisioning form with before_fill method

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.vm_views.RetirementView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Set Retirement date view for vms/instances The title actually as Instance|VM.VM_TYPE string in it, otherwise the same

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.vm_views.RightSizeView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Right Size recommendations page for vms/instances

is_displayed
class cfme.common.vm_views.SelectTable(parent, locator, column_widgets=None, assoc_column=None, rows_ignore_top=None, rows_ignore_bottom=None, top_ignore_fill=False, bottom_ignore_fill=False, logger=None)[source]

Bases: widgetastic_manageiq.Table

Wigdet for non-editable table. used for selecting value

currently_selected

Return Name of the selected row

fill(*args, **kwargs)[source]

Clicks on item - fill by selecting required value

read(*args, **kwargs)[source]
read_content()[source]

This is a default Table.read() method for those who will need table content

class cfme.common.vm_views.SetOwnershipView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Set vms/instance ownership page The title actually as Instance|VM.VM_TYPE string in it, otherwise the same

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.common.vm_views.VMDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Details entities view for vms/instances details destinations

VM’s have 3-4 more tables, should inherit and add them there.

attributes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

compliance

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

diagnostics

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

security

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vmsafe

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.vm_views.VMEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Entities view for vms/instances collection destinations

adv_search_clear

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entity_class
class cfme.common.vm_views.VMToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Toolbar view for vms/instances collection destinations

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents
class cfme.common.PolicyProfileAssignable[source]

Bases: object

This class can be inherited by anything that provider load_details method.

It provides functionality to assign and unassign Policy Profiles

assign_policy_profiles(*policy_profile_names)[source]

Assign Policy Profiles to this object.

Parameters:policy_profile_names – str with Policy Profile names. After Control/Explorer coverage goes in, PolicyProfile objects will be also passable.
assigned_policy_profiles
manage_policies_tree = <cfme.web_ui.BootstrapTreeview object>
unassign_policy_profiles(*policy_profile_names)[source]

Unssign Policy Profiles to this object.

Parameters:policy_profile_names – str with Policy Profile names. After Control/Explorer coverage goes in, PolicyProfile objects will be also passable.
class cfme.common.Summary(o)[source]

Bases: object

Summary container class. An entry point to the summary listing

HEADERS = '//th[@align="left"]'
__iter__()[source]

This enables you to iterate through like it was a dictionary, just without .iteritems

group_names

Returns names of the tables.

groups()[source]

Returns a dictionary of keys (table titles) and table objects.

reload()[source]
class cfme.common.SummaryMixin[source]

Bases: object

Use this mixin to have simple access to the Summary informations of an object.

Requires that the class has load_details(refresh) method defined.

All the names from the UI are “attributized”.

Sample usage:

# You can retrieve the text value as it is in the UI
provider.summary.properties.host_name.text_value  # => 'hostname'
# Or let it guess if it is a number and return float or int
provider.summary.properties.aggregate_host_cpus.value  # => 12
# You can get the image address
provider.summary.foo.bar.img  # => value parsed by urlparse()
# Or the onclick link
provider.summary.foo.bar.link  # => 'http://foo/bar'
# Check if it is clickable
assert provider.summary.xyz.qwer.clickable

# You can iterate like it was a dictionary
for table_name, table in provider.summary:
    # table_name contains title of the table
    for key, value in table:
        # key contains the left cell text, value contains the value holder
        print('{}: {}'.format(key, value.text_value))
summary
class cfme.common.SummaryTable(o, text, entry, skip_load=False)[source]

Bases: object

MULTIKEY_LOC = '../../../tbody/tr[1]/td/strong'
ROWS = '../../../tbody/tr'
items()[source]
keys
load()[source]
raw_keys
reload()[source]
class cfme.common.SummaryValue(el)[source]

Bases: object

click()[source]

A convenience function to click the summary item.

clickable
img
text_value
value
class cfme.common.TagPageView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Class represents common tag page in CFME UI

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
table_title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.common.Taggable[source]

Bases: object

This class can be inherited by anything that provider load_details method.

It provides functionality to assign and unassign tags.

add_tag(tag, single_value=False)[source]
add_tags(tags)[source]

Add list of tags

Parameters:tags – List of Tag
get_tags(*args, **kwargs)
get_tags_db = None
remove_tag(tag)[source]
remove_tags(tags)[source]

Remove list of tags

Parameters:tags – List of Tag
class cfme.common.TimelinesMixin[source]

Bases: object

Use this mixin to have simple access to the Timelines page. To use this TimelinesMixin you have to implement load_timelines_page function, which should take to timelines page

Sample usage:

# Change Timelines showing interval Select
timelines.change_interval('Hourly')
# Change Timelines showing event group Select
timelines.select_event_category('Application')
# Change Level of showed Timelines
timelines.change_level('Detail')
# Check whether timelines contain particular event
# which is generated after provided datetime
timelines.contains_event('hawkular_deployment.ok', before_test_date)
timelines
class cfme.common.TopologyMixin[source]

Bases: object

Use this mixin to have simple access to the Topology page. To use this TopologyMixin you have to implement load_topology_page function, which should take to topology page

Sample usage:

# You can retrieve the elements details as it is in the UI
topology.elements  # => 'hostname'
# You can do actions on topology page
topology.display_names.enable()
topology.display_names.disable()
topology.display_names.is_enabled
# You can do actions on topology search box
topology.search_box.text(text='hello')
topology.search_box.text(text='hello', submit=False)
topology.search_box.submit()
topology.search_box.clear()
# You can get legends and can perform actions
topology.legends
topology.pod.name
topology.pod.is_active
topology.pod.set_active()
# You can get elements, element parents and children
topology.elements
topology.elements[0].parents
topology.elements[0].children
topology.elements[0].double_click()
topology.elements[0].is_displayed()
topology
class cfme.common.UtilizationMixin[source]

Bases: object

Use this mixin to have simple access to the Utilization information of an object.

Requires that the class(page) has load_details(refresh) method and taggable_type should be defined.

All the chart names from the UI are “attributized”.

Sample usage: .. code-block:: python

# You can list available charts page.utilization.charts # => ‘[ ‘jvm_heap_usage_bytes’,’web_sessions’,’transactions’]’ # You can get the data from chart page.utilization.jvm_heap_usage_bytes.list_data_chart() # => returns data as list # You can get the data from table provider.utilization.jvm_heap_usage_bytes.list_data_table() # => returns data as list # You can get the data from wrapanapi page.utilization.jvm_heap_usage_bytes.list_data_mgmt() # => returns data as list # You can change chart option page.utilization.jvm_non_heap_usage_bytes.option.set_by_visible_text(op_interval=’Daily’) # You can list available ledgends page.utilization.jvm_non_heap_usage_bytes.legends # You can enable/disable legends page.utilization.jvm_non_heap_usage_bytes.committed.set_active(active=False) # => Disables page.utilization.jvm_non_heap_usage_bytes.committed.set_active(active=True) # => Enables
utilization
class cfme.common.Validatable[source]

Bases: cfme.common.SummaryMixin

Mixin for various validations. Requires the class to be also Taggable.

:var property_tuples: Tuples which first value is the provider class’s attribute
name, the second value is provider’s UI summary page field key. Should have values in child classes.
property_tuples = []
validate_properties()[source]

Validation method which checks whether class attributes, which were used during creation of provider, are correctly displayed in Properties section of provider UI.

The maps between class attribute and UI property is done via ‘property_tuples’ variable.

Fails if some property does not match.

validate_tags(tag='My Company Tags', reference_tags=None)[source]

Validation method which check tagging between UI and database.

To use this method, self/caller should be extended with Taggable class

Parameters:
  • tag – tag name, default is My Company Tags
  • reference_tags – If you want to compare user input with database, pass user input as reference_tags
class cfme.common.WidgetasticTaggable[source]

Bases: object

This class can be inherited by any class that honors tagging. Class should have following:

  • ‘Details’ navigation
  • ‘Details’ view should have entities.smart_management SummaryTable widget
  • ‘EditTags’ navigation
  • ‘EditTags’ view should have nested ‘form’ view with ‘tags’ table widget
    • Suggest using class cfme.common.TagPageView as view for ‘EditTags’ nav

This class provides functionality to assign and unassigned tags for page models with standardized widgetastic views

add_tag(category=None, tag=None, cancel=False, reset=False)[source]

Add tag to tested item

Parameters:
  • category – category(str)
  • tag – tag(str) or Tag object
  • cancel – set True to cancel tag assigment
  • reset – set True to reset already set up tag
add_tags(tags)[source]

Add multiple tags

Parameters:tags – pass dict with category name as key, and tag as value, or pass list with tag objects
get_tags(tenant='My Company Tags')[source]

Get list of tags assigned to item

Parameters:tenant – string, tags tenant, default is “My Company Tags”
Returns:Tag_name”
Return type:List of tags in format “Tag_category
remove_tag(category=None, tag=None, cancel=False, reset=False)[source]

Remove tag of tested item

Parameters:
  • category – category(str)
  • tag – tag(str) or Tag object
  • cancel – set True to cancel tag deletion
  • reset – set True to reset tag changes
remove_tags(tags)[source]

Remove multiple of tags

Parameters:tags – pass dict with category name as key, and tag as value, or pass list with tag objects
cfme.common.process_field(values)[source]
cfme.configure package
Subpackages
cfme.configure.configuration package
Submodules
cfme.configure.configuration.analysis_profile module
class cfme.configure.configuration.analysis_profile.AnalysisProfile(name, description, profile_type, files=None, events=None, categories=None, registry=None, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.update.Updateable, widgetastic.utils.Fillable, utils.appliance.Navigatable

Analysis profiles, Vm and Host type

Example: Note the keys for files, events, registry should match UI columns

p = AnalysisProfile(name, description, profile_type='VM')
p.files = [
    {"Name": "/some/anotherfile", "Collect_Contents?": True},
]
p.events = [
    {"Name": name, "Filter Message": msg, "Level": lvl, "Source": src, "# of Days": 1},
]
p.registry = [
    {"Registry Key": key, "Registry Value": value},
]
p.categories = ["System", "Software"]  # Use the checkbox text name
p.create()
p2 = p.copy(new_name="updated AP")
with update(p):
    p.files = [{"Name": "/changed". "Collect_Contents?": False}]
p.delete()
CREATE_LOC = None
HOST_TYPE = 'Host'
VM_TYPE = 'Vm'
as_fill_value()[source]

String representation of an Analysis Profile in CFME UI

copy(new_name=None, cancel=False)[source]

Copy the Analysis Profile

create(cancel=False)[source]

Add Analysis Profile to appliance

delete(cancel=False)[source]

Delete self via details page

exists
form_fill_args(updates=None)[source]

Build a dictionary of nested tab_forms for assoc_fill from a flat object dictionary If updates dictionary is passed, it is used instead of self This should work for create or update form fill args

pretty_attrs = ('name', 'description', 'files', 'events')
update(updates, cancel=False)[source]

Update the existing Analysis Profile with given updates dict Make use of Updateable and use with to update object as well Note the updates dict should take the structure below if called directly

Args:
updates (dict): Dictionary of values to change in the object. cancel (boolean): whether to cancel the update
class cfme.configure.configuration.analysis_profile.AnalysisProfileAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AnalysisProfileAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.analysis_profile.AnalysisProfileAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

View for the add form, switches between host/vm based on object type Uses a switchable view based on the profile type widget

AnalysisProfileAddHost = None
AnalysisProfileAddVm = None
add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

form

Conditional switchable view implementation.

This widget proxy is useful when you have a form whose parts displayed depend on certain conditions. Eg. when you select certain value from a dropdown, one form is displayed next, when other value is selected, a different form is displayed next. This widget proxy is designed to register those multiple views and then upon accessing decide which view to use based on the registration conditions.

The resulting widget proxy acts similarly like a nested view (if you use view of course).

Example

class SomeForm(View):
    foo = Input('...')
    action_type = Select(name='action_type')

    action_form = ConditionalSwitchableView(reference='action_type')

    # Simple value matching. If Action type 1 is selected in the select, use this view.
    # And if the action_type value does not get matched, use this view as default
    @action_form.register('Action type 1', default=True)
    class ActionType1Form(View):
        widget = Widget()

    # You can use a callable to declare the widget values to compare
    @action_form.register(lambda action_type: action_type == 'Action type 2')
    class ActionType2Form(View):
        widget = Widget()

    # With callable, you can use values from multiple widgets
    @action_form.register(
        lambda action_type, foo: action_type == 'Action type 2' and foo == 2)
    class ActionType2Form(View):
        widget = Widget()

You can see it gives you the flexibility of decision based on the values in the view.

Parameters:
  • reference – For using non-callable conditions, this must be specified. Specifies the name of the widget whose value will be used for comparing non-callable conditions. Supports going across objects using ..
  • ignore_bad_reference – If this is enabled, then when the widget representing the reference is not displayed or otherwise broken, it will then use the default view.
is_displayed
profile_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.analysis_profile.AnalysisProfileAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AnalysisProfileAllView

prerequisite

This is a helper descriptor for navigation destinations which are on another class/object.

For instance, imagine you have a different object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToObject as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step on the other object.

step()[source]
class cfme.configure.configuration.analysis_profile.AnalysisProfileAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

View for the Analysis Profile collection page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
paginator

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.analysis_profile.AnalysisProfileBaseAddForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

View for the common elements of the two AP forms

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

events

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

files

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.analysis_profile.AnalysisProfileCopy(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AnalysisProfileCopyView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.analysis_profile.AnalysisProfileCopyView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.configuration.analysis_profile.AnalysisProfileAddView

View for the copy form is the same as an add

The name field is by default set with ‘Copy of [profile name of copy source] Don’t want to assert against this field to separately verify the view is displayed If is_displayed is called after the form is changed it will be false negative

class cfme.configure.configuration.analysis_profile.AnalysisProfileDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AnalysisProfileDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.analysis_profile.AnalysisProfileDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Main content on an analysis profile details page

info_description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

info_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

info_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.analysis_profile.AnalysisProfileDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

View for an analysis profile details page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.analysis_profile.AnalysisProfileEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AnalysisProfileEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.analysis_profile.AnalysisProfileEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.configuration.analysis_profile.AnalysisProfileAddView

View for the edit form, extends add view since all fields are the same and editable

is_displayed
reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.analysis_profile.AnalysisProfileEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Main content on the analysis profiles configuration page, title and table

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.analysis_profile.AnalysisProfileToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Toolbar on the analysis profiles configuration page Works for both all page and details page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.configure.configuration.region_settings module
class cfme.configure.configuration.region_settings.CANDUCollection(appliance=None)[source]

Bases: utils.appliance.Navigatable

Class represents a C and U in CFME UI

disable_all(reset=False)[source]

Disable C and U

Parameters:reset – Reset changes, default is ‘False’ - changes will not be reset
enable_all(reset=False)[source]

Enable C and U

Parameters:reset – Reset changes, default is ‘False’ - changes will not be reset
class cfme.configure.configuration.region_settings.CANDUCollectionDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CANDUCollectionView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.CANDUCollectionView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.RegionView

C and U View

all_clusters_cb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

all_datastores_cb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.Category(name=None, display_name=None, description=None, show_in_console=True, single_value=True, capture_candu=False, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable, utils.update.Updateable

Class represents a category in CFME UI

Parameters:
  • name – Name of the category
  • display_name – Category display name
  • description – Category description
  • show_in_console – Option to show category in console (True/False)
  • single_value – Option if category is single value (True/False)
  • capture_candu – True/False, capture c&u data by tag
create(cancel=False)[source]

Create category method

Parameters:cancel – To cancel creation pass True, cancellation message will be verified By defaul user will be created
delete(cancel=True)[source]

Delete existing category

Parameters:cancel – Default value ‘True’, category will be deleted ‘False’ - deletion of category will be canceled
pretty_attrs = ['name', 'display_name', 'description', 'show_in_console', 'single_value', 'capture_candu']
update(updates, cancel=False)[source]

Update category method

Parameters:updates – category data that should be changed
class cfme.configure.configuration.region_settings.CategoryAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CompanyCategoriesAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.CategoryAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CompanyCategoriesAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.CategoryEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CompanyCategoriesEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.CompanyCategoriesAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.configuration.region_settings.CompanyCategoriesAllView

Add Company Categories View

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

capture_candu

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
long_description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

show_in_console

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

single_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.CompanyCategoriesAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.RegionView

Company Categories List View

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.CompanyCategoriesEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.configuration.region_settings.CompanyCategoriesAddView

Edit Company Categories View

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.CompanyTagsAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.configuration.region_settings.CompanyTagsAllView

Add Company Tags view

is_displayed
tag_description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.CompanyTagsAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.RegionView

Company Tags list view

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

category_dropdown

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.CompanyTagsEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.configuration.region_settings.CompanyTagsAddView

Edit Company Tags view

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RedHatUpdatesView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RedHatUpdatesEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.MapTags(entity=None, label=None, category=None, appliance=None)[source]

Bases: utils.appliance.Navigatable, utils.pretty.Pretty, utils.update.Updateable

Class represents a category in CFME UI

Parameters:
  • entity – Name of the tag
  • label – Tag display name
  • category – Tags Category
create(cancel=False)[source]

Map tags creation method

Parameters:cancel – True - if you want to cancel map creation, by defaul map will be created
delete(cancel=False)[source]

Delete existing user

Parameters:cancel – Default value ‘False’, map will be deleted ‘True’ - map will not be deleted
pretty_attrs = ['entity', 'label', 'category']
update(updates, cancel=False)[source]

Update tag map method

Parameters:
  • updates – tag map data that should be changed
  • cancel – True - if you want to cancel map edition, by defaul map will be updated
class cfme.configure.configuration.region_settings.MapTagsAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MapTagsAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.MapTagsAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.RegionView

Add Map Tags view

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

category

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
resource_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

resource_label

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.MapTagsAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MapTagsAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.MapTagsAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.RegionView

Map Tags list view

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.MapTagsEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MapTagsEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.MapTagsEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.configuration.region_settings.MapTagsAddView

Edit Map Tags view

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.RedHatUpdates(service, url, username, password, password_verify=None, repo_name=None, organization=None, use_proxy=False, proxy_url=None, proxy_username=None, proxy_password=None, proxy_password_verify=None, set_default_rhsm_address=False, set_default_repository=False, appliance=None)[source]

Bases: utils.appliance.Navigatable, utils.pretty.Pretty

Class represents a Red Hat updates tab in CFME UI

Parameters:
  • service – Service type (registration method).
  • url – Service server URL address.
  • username – Username to use for registration.
  • password – Password to use for registration.
  • password_verify – 2nd entry of password for verification. Same as ‘password’ if None.
  • repo_name – Repository/channel to enable.
  • organization – Organization (sat6 only).
  • use_proxy – True if proxy should be used, False otherwise (default False).
  • proxy_url – Address of the proxy server.
  • proxy_username – Username for the proxy server.
  • proxy_password – Password for the proxy server.
  • proxy_password_verify – 2nd entry of proxy server password for verification. Same as ‘proxy_password’ if None.
  • set_default_rhsm_address – Click the Default button connected to the RHSM (only) address if True
  • set_default_repository – Click the Default button connected to the repo/channel if True
  • Note – With satellite 6, it is necessary to validate credentials to obtain available organizations from the server. With satellite 5, ‘validate’ parameter is ignored because there is no validation button available.
check_updates(*appliance_names)[source]

Run update check on appliances by names

Parameters:appliance_names – Names of appliances to check; will check all if empty
checked_updates(*appliance_names)[source]

Check if appliances checked if there is an update available

Parameters:appliance_names – Names of appliances to check; will check all if empty
get_appliance_rows(*appliance_names)[source]

Get appliances as table rows

Parameters:appliance_names – Names of appliances to get; will get all if empty
get_available_version()[source]

Get available version printed on the page

Returns:None if not available; string with version otherwise e.g. 1.2.2.3
get_repository_names()[source]

Get available repositories names

Returns:summary info for repositories names
Return type:string
is_registered(*appliance_names)[source]

Check if each appliance is registered

Parameters:appliance_names – Names of appliances to check; will check all if empty
is_registering(*appliance_names)[source]

Check if at least one appliance is registering

is_subscribed(*appliance_names)[source]

Check if appliances are subscribed

Parameters:appliance_names – Names of appliances to check; will check all if empty
platform_updates_available(*appliance_names)[source]

Check if appliances have a platform update available

Parameters:appliance_names – Names of appliances to check; will check all if empty
pretty_attrs = ['service', 'url', 'username', 'password']
refresh()[source]

Click refresh button to update statuses of appliances

register_appliances(*appliance_names)[source]

Register appliances by names

Parameters:appliance_names – Names of appliances to register; will register all if empty
select_appliances(*appliance_names)[source]

Select appliances by names

Parameters:appliance_names – Names of appliances to select; will select all if empty
service_types = {'rhsm': 'Red Hat Subscription Management', 'sat6': 'Red Hat Satellite 6'}
update_appliances(*appliance_names)[source]

Update appliances by names

Parameters:appliance_names – Names of appliances to update; will update all if empty
update_registration(validate=True, cancel=False)[source]

Fill in the registration form, validate and save/cancel

Parameters:
  • validate – Click the Validate button and check the flash message for errors if True (default True)
  • cancel – Click the Cancel button if True or the Save button if False (default False)
versions_match(version, *appliance_names)[source]

Check if versions of appliances match version

Parameters:
  • version – Version to match against
  • appliance_names – Names of appliances to check; will check all if empty
class cfme.configure.configuration.region_settings.RedHatUpdatesEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.RegionView

Red Hat Updates edit view

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password_verify

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

proxy_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

proxy_password_verify

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

proxy_url

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

proxy_username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

register_to

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

repo_default_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

repo_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

rhn_default_url

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

url

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

use_proxy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

validate_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.RedHatUpdatesView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.RegionView

Red Hat Updates details view

apply_cfme_update

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

available_update_version

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

check_for_updates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

edit_registration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
refresh

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

register

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

repository_names_info

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

updates_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.configuration.region_settings.Tag(name=None, display_name=None, category=None, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable, utils.update.Updateable

Class represents a category in CFME UI :param name: Name of the tag :param display_name: Tag display name :param category: Tags Category

create()[source]

Create category method

delete(cancel=True)[source]

Delete category method

pretty_attrs = ['name', 'display_name', 'category']
update(updates)[source]

Update category method

class cfme.configure.configuration.region_settings.TagsAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CompanyTagsAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.TagsAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CompanyTagsAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.region_settings.TagsEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CompanyTagsEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
Module contents
class cfme.configure.configuration.AmazonAuthSetting(access_key, secret_key, get_groups=False, timeout_h=None, timeout_m=None)[source]

Bases: cfme.configure.configuration.AuthSetting

Authentication settings via Amazon.

Parameters:
  • access_key – Amazon access key
  • secret_key – Amazon secret key
  • get_groups – Whether to get groups from the auth provider (default False)
  • timeout_h – Timeout in hours
  • timeout_m – Timeout in minutes

Usage:

amiauth = AmazonAuthSetting("AJSHDGVJAG", "IUBDIUWQBQW")
amiauth.update()
form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>}), ('auth_mode', {Version('lowest'): Select('select#authentication_mode', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_mode']", none=None, multi=False, exact=False>}), ('access_key', <cfme.web_ui.Input _names=('authentication_amazon_key',), _use_id=False>), ('secret_key', <cfme.web_ui.Input _names=('authentication_amazon_secret',), _use_id=False>), ('get_groups', <cfme.web_ui.Input _names=('amazon_role',), _use_id=False>)]>
pretty_attrs = ['access_key', 'secret_key', 'get_groups', 'timeout_h', 'timeout_m']
update(updates=None)[source]
class cfme.configure.configuration.AuthSetting[source]

Bases: utils.update.Updateable, utils.pretty.Pretty

form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>})]>
classmethod set_session_timeout(hours=None, minutes=None)[source]

Sets the session timeout of the appliance.

class cfme.configure.configuration.BasicInformation(company_name=None, appliance_name=None, appliance_zone=None, time_zone=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

This class represents the “Basic Info” section of the Configuration page.

Parameters:
  • company_name – Company name.
  • appliance_name – Appliance name.
  • appliance_zone – Appliance Zone.
  • time_zone – Time Zone.

Usage:

basic_info = BasicInformation(company_name="ACME Inc.")
basic_info.update()
basic_information = <cfme.web_ui.Form fields=[('company_name', <cfme.web_ui.Input _names=('server_company',), _use_id=False>), ('appliance_name', <cfme.web_ui.Input _names=('server_name',), _use_id=False>), ('appliance_zone', Select('select#server_zone', multi=False)), ('time_zone', Select('select#server_timezone', multi=False))]>
pretty_attrs = ['company_name', 'appliance_name', 'appliance_zone', 'time_zone', 'appliance']
update()[source]

Navigate to a correct page, change details and save.

class cfme.configure.configuration.Category(name=None, display_name=None, description=None, show_in_console=True, single_value=True, capture_candu=False, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

create(cancel=False)[source]
delete(cancel=True)[source]
pretty_attrs = ['name', 'display_name', 'description', 'show_in_console', 'single_value', 'capture_candu']
update(updates, cancel=False)[source]
class cfme.configure.configuration.CategoryAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

Unlike most other Add operations, this one requires an instance

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.CategoryAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.CategoryEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.DatabaseAuthSetting(timeout_h=None, timeout_m=None)[source]

Bases: cfme.configure.configuration.AuthSetting

Authentication settings for DB internal database.

Parameters:
  • timeout_h – Timeout in hours
  • timeout_m – Timeout in minutes

Usage:

dbauth = DatabaseAuthSetting()
dbauth.update()
form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>}), ('auth_mode', {Version('lowest'): Select('select#authentication_mode', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_mode']", none=None, multi=False, exact=False>})]>
pretty_attrs = ['timeout_h', 'timeout_m']
update(updates=None)[source]
class cfme.configure.configuration.DatabaseBackupSchedule(name, description, active=True, protocol=None, depot_name=None, uri=None, username=None, password=None, password_verify=None, run_type='Once', run_every=None, time_zone=None, start_date=None, start_hour=None, start_min=None)[source]

Bases: cfme.configure.configuration.Schedule

Configure/Configuration/Region/Schedules - Database Backup type

Parameters:
  • name – Schedule name
  • description – Schedule description
  • active – Whether the schedule should be active (default True)
  • protocol – One of {'Samba', 'Network File System'}
  • run_type – Once, Hourly, Daily, ...
  • run_every – If run_type is not Once, then you can specify how often it should be run
  • time_zone – Time zone selection
  • start_date – Specify start date (mm/dd/yyyy or datetime.datetime())
  • start_hour – Starting hour
  • start_min – Starting minute

Usage:

smb_schedule = DatabaseBackupSchedule(
    name="Bi-hourly Samba Database Backup",
    description="Everybody's favorite backup schedule",
    protocol="Samba",
    uri="samba.example.com/share_name",
    username="samba_user",
    password="secret",
    password_verify="secret",
    time_zone="UTC",
    start_date=datetime.datetime.utcnow(),
    run_type="Hourly",
    run_every="2 Hours"
)
smb_schedule.create()
smb_schedule.delete()

... or ...

nfs_schedule = DatabaseBackupSchedule(
    name="One-time NFS Database Backup",
    description="The other backup schedule",
    protocol="Network File System",
    uri="nfs.example.com/path/to/share",
    time_zone="Chihuahua",
    start_date="21/6/2014",
    start_hour="7",
    start_min="45"
)
nfs_schedule.create()
nfs_schedule.delete()
create(cancel=False, samba_validate=False)[source]

Create a new schedule from the informations stored in the object.

Parameters:
  • cancel – Whether to click on the cancel button to interrupt the creation.
  • samba_validate – Samba-only option to click the Validate button to check if entered samba credentials are valid or not
form = <cfme.web_ui.Form fields=[('name', <cfme.web_ui.Input _names=('name',), _use_id=False>), ('description', <cfme.web_ui.Input _names=('description',), _use_id=False>), ('active', <cfme.web_ui.Input _names=('enabled',), _use_id=False>), ('action', {Version('lowest'): Select('select#action_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='action_typ']", none=None, multi=False, exact=False>}), ('log_protocol', {Version('lowest'): Select('select#log_protocol', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='log_protocol']", none=None, multi=False, exact=False>}), ('depot_name', <cfme.web_ui.Input _names=('depot_name',), _use_id=False>), ('uri', <cfme.web_ui.Input _names=('uri',), _use_id=False>), ('log_userid', <cfme.web_ui.Input _names=('log_userid',), _use_id=False>), ('log_password', <cfme.web_ui.Input _names=('log_password',), _use_id=False>), ('log_verify', <cfme.web_ui.Input _names=('log_verify',), _use_id=False>), ('timer_type', {Version('lowest'): Select('select#timer_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='timer_typ']", none=None, multi=False, exact=False>}), ('timer_hours', Select('select#timer_hours', multi=False)), ('timer_days', Select('select#timer_days', multi=False)), ('timer_weeks', Select('select#timer_weekss', multi=False)), ('timer_months', Select('select#timer_months', multi=False)), ('timer_value', <cfme.web_ui.AngularSelect _loc="//button[@data-id='timer_value']", none=None, multi=False, exact=False>, {'appeared_in': '5.5'}), ('time_zone', <cfme.web_ui.AngularSelect _loc="//button[@data-id='time_zone']", none=None, multi=False, exact=False>), ('start_date', <cfme.web_ui.Calendar >), ('start_hour', <cfme.web_ui.AngularSelect _loc="//button[@data-id='start_hour']", none=None, multi=False, exact=False>), ('start_min', <cfme.web_ui.AngularSelect _loc="//button[@data-id='start_min']", none=None, multi=False, exact=False>)]>
last_date
update(updates, cancel=False, samba_validate=False)[source]

Modify an existing schedule with informations from this instance.

Parameters:
  • updates – Dict with fields to be updated
  • cancel – Whether to click on the cancel button to interrupt the editation.
  • samba_validate – Samba-only option to click the Validate button to check if entered samba credentials are valid or not
class cfme.configure.configuration.ExternalAuthSetting(get_groups=False, timeout_h='1', timeout_m='0')[source]

Bases: cfme.configure.configuration.AuthSetting

Authentication settings for authentication via httpd.

Parameters:
  • timeout_h – Timeout in hours
  • timeout_m – Timeout in minutes
  • get_groups – Get user groups from external auth source.

Usage:

dbauth = ExternalAuthSetting(get_groups=True)
dbauth.update()
form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>}), ('auth_mode', {Version('lowest'): Select('select#authentication_mode', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_mode']", none=None, multi=False, exact=False>}), ('get_groups', <cfme.web_ui.Input _names=('httpd_role',), _use_id=False>)]>
pretty_attrs = ['timeout_h', 'timeout_m', 'get_groups']
setup()[source]
update(updates=None)[source]
class cfme.configure.configuration.LDAPAuthSetting(hosts, user_type, user_suffix, base_dn=None, bind_dn=None, bind_password=None, get_groups=False, get_roles=False, follow_referrals=False, port=None, timeout_h=None, timeout_m=None)[source]

Bases: cfme.configure.configuration.AuthSetting

Authentication via LDAP

Parameters:
  • hosts – List of LDAP servers (max 3).
  • user_type – “userprincipalname”, “mail”, ...
  • user_suffix – User suffix.
  • base_dn – Base DN.
  • bind_dn – Bind DN.
  • bind_password – Bind Password.
  • get_groups – Get user groups from LDAP.
  • get_roles – Get roles from home forest.
  • follow_referrals – Follow Referrals.
  • port – LDAP connection port.
  • timeout_h – Timeout in hours
  • timeout_m – Timeout in minutes

Usage:

ldapauth = LDAPAuthSetting(
    ["host1", "host2"],
    "mail",
    "user.acme.com"
)
ldapauth.update()
AUTH_MODE = 'LDAP'
form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>}), ('auth_mode', {Version('lowest'): Select('select#authentication_mode', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_mode']", none=None, multi=False, exact=False>}), ('ldaphost_1', <cfme.web_ui.Input _names=('authentication_ldaphost_1',), _use_id=False>), ('ldaphost_2', <cfme.web_ui.Input _names=('authentication_ldaphost_2',), _use_id=False>), ('ldaphost_3', <cfme.web_ui.Input _names=('authentication_ldaphost_3',), _use_id=False>), ('port', <cfme.web_ui.Input _names=('authentication_ldapport',), _use_id=False>), ('user_type', {Version('lowest'): Select('select#authentication_user_type', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_user_type']", none=None, multi=False, exact=False>}), ('user_suffix', <cfme.web_ui.Input _names=('authentication_user_suffix',), _use_id=False>), ('get_groups', <cfme.web_ui.Input _names=('ldap_role',), _use_id=False>), ('get_roles', <cfme.web_ui.Input _names=('get_direct_groups',), _use_id=False>), ('default_groups', {Version('lowest'): Select('select#authentication_default_group_for_users', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_default_group_for_users']", none=None, multi=False, exact=False>}), ('get_direct_groups', <cfme.web_ui.Input _names=('get_direct_groups',), _use_id=False>), ('follow_referrals', <cfme.web_ui.Input _names=('follow_referrals',), _use_id=False>), ('base_dn', <cfme.web_ui.Input _names=('authentication_basedn',), _use_id=False>), ('bind_dn', <cfme.web_ui.Input _names=('authentication_bind_dn',), _use_id=False>), ('bind_password', <cfme.web_ui.Input _names=('authentication_bind_pwd',), _use_id=False>)]>
pretty_attrs = ['hosts', 'user_type', 'user_suffix', 'base_dn', 'bind_dn', 'bind_password']
update(updates=None)[source]
class cfme.configure.configuration.LDAPSAuthSetting(hosts, user_type, user_suffix, base_dn=None, bind_dn=None, bind_password=None, get_groups=False, get_roles=False, follow_referrals=False, port=None, timeout_h=None, timeout_m=None)[source]

Bases: cfme.configure.configuration.LDAPAuthSetting

Authentication via LDAPS

Parameters:
  • hosts – List of LDAPS servers (max 3).
  • user_type – “userprincipalname”, “mail”, ...
  • user_suffix – User suffix.
  • base_dn – Base DN.
  • bind_dn – Bind DN.
  • bind_password – Bind Password.
  • get_groups – Get user groups from LDAP.
  • get_roles – Get roles from home forest.
  • follow_referrals – Follow Referrals.
  • port – LDAPS connection port.
  • timeout_h – Timeout in hours
  • timeout_m – Timeout in minutes

Usage:

ldapauth = LDAPSAuthSetting(
    ["host1", "host2"],
    "mail",
    "user.acme.com"
)
ldapauth.update()
AUTH_MODE = 'LDAPS'
class cfme.configure.configuration.SMTPSettings(host=None, port=None, domain=None, start_tls=None, ssl_verify=None, auth=None, username=None, password=None, from_email=None, test_email=None)[source]

Bases: utils.update.Updateable

SMTP settings on the main page.

Parameters:
  • host – SMTP Server host name
  • port – SMTP Server port
  • domain – E-mail domain
  • start_tls – Whether use StartTLS
  • ssl_verify – SSL Verification
  • auth – Authentication type
  • username – User name
  • password – User password
  • from_email – E-mail address to be used as the “From:”
  • test_email – Destination of the test-email.

Usage:

smtp = SMTPSettings(
    host="smtp.acme.com",
    start_tls=True,
    auth="login",
    username="mailer",
    password="secret"
)
smtp.update()

Note: TODO: send a test-email, if that will be needed.

buttons = <cfme.web_ui.Region title=None>
classmethod send_test_email(to_address)[source]

Send a testing e-mail on specified address. Needs configured SMTP.

Parameters:to_address – Destination address.
smtp_settings = <cfme.web_ui.Form fields=[('host', <cfme.web_ui.Input _names=('smtp_host',), _use_id=False>), ('port', <cfme.web_ui.Input _names=('smtp_port',), _use_id=False>), ('domain', <cfme.web_ui.Input _names=('smtp_domain',), _use_id=False>), ('start_tls', <cfme.web_ui.Input _names=('smtp_enable_starttls_auto',), _use_id=False>), ('ssl_verify', <cfme.web_ui.AngularSelect _loc="//button[@data-id='smtp_openssl_verify_mode']", none=None, multi=False, exact=False>), ('auth', <cfme.web_ui.AngularSelect _loc="//button[@data-id='smtp_authentication']", none=None, multi=False, exact=False>), ('username', <cfme.web_ui.Input _names=('smtp_user_name',), _use_id=False>), ('password', <cfme.web_ui.Input _names=('smtp_password',), _use_id=False>), ('from_email', <cfme.web_ui.Input _names=('smtp_from',), _use_id=False>), ('to_email', <cfme.web_ui.Input _names=('smtp_test_to',), _use_id=False>)]>
update()[source]
class cfme.configure.configuration.Schedule(name, description, active=True, action=None, filter_type=None, filter_value=None, run_type='Once', run_every=None, time_zone=None, start_date=None, start_hour=None, start_min=None, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

Configure/Configuration/Region/Schedules functionality

Create, Update, Delete functionality.

Parameters:
  • name – Schedule’s name.
  • description – Schedule description.
  • active – Whether the schedule should be active (default True)
  • action – Action type
  • filter_type – Filtering type
  • filter_value – If a more specific filter_type is selected, here is the place to choose hostnames, machines and so ...
  • run_type – Once, Hourly, Daily, ...
  • run_every – If run_type is not Once, then you can specify how often it should be run.
  • time_zone – Time zone selection.
  • start_date – Specify start date (mm/dd/yyyy or datetime.datetime()).
  • start_hour – Starting hour
  • start_min – Starting minute.

Usage:

schedule = Schedule(
    "My very schedule",
    "Some description here.",
    action="Datastore Analysis",
    filter_type="All Datastores for Host",
    filter_value="datastore.intra.acme.com",
    run_type="Hourly",
    run_every="2 Hours"
)
schedule.create()
schedule.disable()
schedule.enable()
schedule.delete()
# Or
Schedule.enable_by_names("One schedule", "Other schedule")
# And so.

Note: TODO: Maybe the row handling might go into Table class?

create(cancel=False)[source]

Create a new schedule from the informations stored in the object.

Parameters:cancel – Whether to click on the cancel button to interrupt the creation.
delete(cancel=False)[source]

Delete the schedule represented by this object.

Calls the class method with the name of the schedule taken out from the object.

Parameters:cancel – Whether to click on the cancel button in the pop-up.
disable()[source]

Enable the schedule via table checkbox and Configuration menu.

enable()[source]

Enable the schedule via table checkbox and Configuration menu.

form = <cfme.web_ui.Form fields=[('name', <cfme.web_ui.Input _names=('name',), _use_id=False>), ('description', <cfme.web_ui.Input _names=('description',), _use_id=False>), ('active', <cfme.web_ui.Input _names=('enabled',), _use_id=False>), ('action', {Version('lowest'): Select('select#action_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='action_typ']", none=None, multi=False, exact=False>}), ('filter_type', {Version('lowest'): Select('select#filter_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='filter_typ']", none=None, multi=False, exact=False>}), ('filter_value', {Version('lowest'): Select('select#filter_value', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='filter_value']", none=None, multi=False, exact=False>}), ('timer_type', {Version('lowest'): Select('select#timer_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='timer_typ']", none=None, multi=False, exact=False>}), ('timer_hours', Select('select#timer_hours', multi=False)), ('timer_days', Select('select#timer_days', multi=False)), ('timer_weeks', Select('select#timer_weekss', multi=False)), ('timer_months', Select('select#timer_months', multi=False)), ('timer_value', <cfme.web_ui.AngularSelect _loc="//button[@data-id='timer_value']", none=None, multi=False, exact=False>, {'appeared_in': '5.5'}), ('time_zone', {Version('lowest'): Select('select#time_zone', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='time_zone']", none=None, multi=False, exact=False>}), ('start_date', <cfme.web_ui.Calendar >), ('start_hour', {Version('lowest'): Select('select#start_hour', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='start_hour']", none=None, multi=False, exact=False>}), ('start_min', {Version('lowest'): Select('select#start_min', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='start_min']", none=None, multi=False, exact=False>})]>
pretty_attrs = ['name', 'description', 'run_type', 'run_every', 'start_date', 'start_hour', 'start_min']
select()[source]

Select the checkbox for current schedule

tab = {'Monthly': 'timer_months', 'Hourly': 'timer_hours', 'Daily': 'timer_days', 'Weekly': 'timer_weeks'}
update(updates, cancel=False)[source]

Modify an existing schedule with informations from this instance.

Parameters:
  • updates – Dict with fields to be updated
  • cancel – Whether to click on the cancel button to interrupt the editation.
class cfme.configure.configuration.ScheduleAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.ScheduleAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are on another class/object.

For instance, imagine you have a different object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToObject as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step on the other object.

step()[source]
class cfme.configure.configuration.ScheduleDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.ScheduleEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.ServerLogDepot(depot_type, depot_name=None, uri=None, username=None, password=None, zone_collect=False, second_server_collect=False, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

This class represents the ‘Collect logs’ for the server.

Usage:

log_credentials = configure.ServerLogDepot("anon_ftp",
                                       depot_name=fauxfactory.gen_alphanumeric(),
                                       uri=fauxfactory.gen_alphanumeric())
log_credentials.create()
log_credentials.clear()
clear()[source]

Set depot type to “No Depot”

collect_all()[source]

Initiate and wait for collection of all logs to finish.

collect_current()[source]

Initiate and wait for collection of the current log to finish.

create(cancel=False)[source]
is_cleared
last_collection
last_message
class cfme.configure.configuration.Tag(name=None, display_name=None, category=None, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

create()[source]
delete(cancel=True)[source]
pretty_attrs = ['name', 'display_name', 'category']
update(updates)[source]
class cfme.configure.configuration.TagsAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

Unlike most other Add operations, this one requires an instance

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.TagsAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.TagsEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.configuration.VMwareConsoleSupport(console_type, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

This class represents the “VMware Console Support” section of the Configuration page. Note this is to support CFME 5.8 and beyond functionality.

Parameters:console_type – One of the following strings ‘VMware VMRC Plugin’, ‘VNC’ or ‘VMware WebMKS’

Usage:

vmware_console_support = VMwareConsoleSupport(console_type="VNC")
vmware_console_support.update()
CONSOLE_TYPES = ['VNC', 'VMware VMRC Plugin', 'VMware WebMKS']
pretty_attrs = ['console_type']
update()[source]

Navigate to a correct page, change details and save.

vmware_console_form = <cfme.web_ui.Form fields=[('console_type', <cfme.web_ui.AngularSelect _loc="//button[@data-id='console_type']", none=None, multi=False, exact=False>)]>
cfme.configure.configuration.get_ntp_servers()[source]
cfme.configure.configuration.get_replication_backlog(navigate=True)[source]

Gets replication backlog from Configure / Configuration pages.

Returns: int representing the remaining items in the replication backlog.

cfme.configure.configuration.get_replication_status(navigate=True)[source]

Gets replication status from Configure / Configuration pages.

Returns: bool of whether replication is Active or Inactive.

cfme.configure.configuration.get_server_roles(navigate=True, db=True)[source]

Get server roles from Configure / Configuration

Returns: dict with the roles in the same format as set_server_roles()
accepts as kwargs.
cfme.configure.configuration.get_workers_list(do_not_navigate=False, refresh=True)[source]

Retrieves all workers.

Returns a dictionary where keys are names of the workers and values are lists (because worker can have multiple instances) which contain dictionaries with some columns.

cfme.configure.configuration.restart_workers(name, wait_time_min=1)[source]

Restarts workers by their name.

Parameters:name – Name of the worker. Multiple workers can have the same name. Name is matched with in

Returns: bool whether the restart succeeded.

cfme.configure.configuration.server_roles_disabled(*roles)[source]
cfme.configure.configuration.server_roles_enabled(*roles)[source]
cfme.configure.configuration.set_auth_mode(mode, **kwargs)[source]

Set up authentication mode

Parameters:
  • mode – Authentication mode to set up.
  • kwargs – A dict of keyword arguments used to initialize one of the *AuthSetting classes - class type is mode-dependent.
Raises:

AuthModeUnknown – when the given mode is not valid
cfme.configure.configuration.set_ntp_servers(*servers)[source]

Set NTP servers on Configure / Configuration pages.

Parameters:*servers – Maximum of 3 hostnames.
cfme.configure.configuration.set_replication_worker_host(host, port='5432')[source]

Set replication worker host on Configure / Configuration pages.

Parameters:host – Address of the hostname to replicate to.
cfme.configure.configuration.set_server_roles(db=True, **roles)[source]

Set server roles on Configure / Configuration pages.

Parameters:**roles – Roles specified as in server_roles Form in this module. Set to True or False
cfme.configure.configuration.setup_authmode_database()[source]
Submodules
cfme.configure.about module
class cfme.configure.about.AboutView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The view for the about modal

is_displayed
modal

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.configure.about.get_detail(field)[source]

Open the about modal and fetch the value for one of the fields ‘title’ and ‘trademark’ fields are allowed and get the header/footer values Raises ElementOrBlockNotFound if the field isn’t in the about modal :param field: string label for the detail field :return: string value from the requested field

cfme.configure.access_control module
class cfme.configure.access_control.AddGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.GroupForm

Add Group View in CFME UI

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.configure.access_control.AddRoleView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.RoleForm

Add Role View

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.configure.access_control.AddTenantView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.TenantForm

Add Tenant View

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.configure.access_control.AddUserView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.UserForm

Add User View.

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.configure.access_control.AllGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

All Groups View in CFME UI

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.AllRolesView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

All Roles View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.AllTenantView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

All Tenants View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.AllUserView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

All Users View.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.DetailsGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Details Group View in CFME UI

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.DetailsRoleView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.RoleForm

Details Role View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.DetailsTenantView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Details Tenant View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.DetailsUserView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

User Details view.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.EditGroupSequence(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditGroupSequenceView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.EditGroupSequenceView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Edit Groups Sequence View in CFME UI

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

group_order_selector

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.EditGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.GroupForm

Edit Group View in CFME UI

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.EditRoleView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.RoleForm

Edit Role View

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.EditTagsUserView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Tags edit for Users view.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.EditTenantView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.TenantForm

Edit Tenant View

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.EditUserView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.UserForm

User Edit View.

cancel_password_change

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

change_stored_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.Group(description=None, role=None, tenant='My Company', user_to_lookup=None, ldap_credentials=None, tag=None, host_cluster=None, vm_template=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Represents a group in CFME UI

Parameters:
  • description – group description
  • role – group role
  • tenant – group tenant
  • user_to_lookup – ldap user to lookup
  • ldap_credentials – ldap user credentials
  • tag – tag for group restriction
  • host_cluster – host/cluster for group restriction
  • vm_template – vm/template for group restriction
  • appliance – appliance under test
add_group_from_ext_auth_lookup()[source]

Adds a group from external authorization lookup

add_group_from_ldap_lookup()[source]

Adds a group from ldap lookup

create(cancel=False)[source]

Create group method

Parameters:cancel – True - if you want to cancel group creation, by defaul group will be created
delete(cancel=True)[source]

Delete existing group

Parameters:cancel – Default value ‘True’, group will be deleted ‘False’ - deletion of group will be canceled
edit_tags(tag, value)[source]

Edits tag for existing group

Parameters:
  • tag – Tag category
  • value – Tag name
exists
group_order
pretty_attrs = ['description', 'role']
remove_tag(tag, value)[source]

Delete tag for existing group

Parameters:
  • tag – Tag category
  • value – Tag name
set_group_order(updated_order)[source]

Sets group order for group lookup

Parameters:updated_order – group order list
update(updates)[source]

Update group method

Parameters:updates – group data that should be changed

Note: In case updates is the same as original group data, update will be canceled, as ‘Save’ button will not be active

class cfme.configure.access_control.GroupAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddGroupView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.GroupAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AllGroupView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.GroupDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsGroupView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.GroupEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditGroupView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.GroupEditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Edit Groups Tags View in CFME UI

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.GroupForm(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Group Form in CFME UI.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

group_tenant

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hosts_and_clusters

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ldap_groups_for_user

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lookup_ldap_groups_chk

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

my_company_tags

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

retrieve_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

role_select

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

user_to_look_up

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vms_and_templates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.GroupTagsEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of GroupEditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.ParentDetailsTenantView(parent, logger=None, **kwargs)[source]

Bases: cfme.configure.access_control.DetailsTenantView

Parent Tenant Details View

is_displayed
class cfme.configure.access_control.Project(name=None, description=None, parent_tenant=None, _default=False, appliance=None)[source]

Bases: cfme.configure.access_control.Tenant

Class representing CFME projects in the UI.

Project cannot create more child tenants/projects.

Parameters:
  • name – Name of the project
  • description – Description of the project
  • parent_tenant – Parent project, can be None, can be passed as string or object
class cfme.configure.access_control.Role(name=None, vm_restriction=None, product_features=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Represents a role in CFME UI

Parameters:
  • name – role name
  • vm_restriction – restriction used for role
  • product_features – product feature to select
  • appliance – appliance unter test
copy(name=None)[source]

Creates copy of existing role

Returns: Role object of copied role

create(cancel=False)[source]

Create role method

Parameters:cancel – True - if you want to cancel role creation, by defaul, role will be created
delete(cancel=True)[source]

Delete existing role

Parameters:cancel – Default value ‘True’, role will be deleted ‘False’ - deletion of role will be canceled
pretty_attrs = ['name', 'product_features']
set_role_product_features(view, product_features)[source]

Sets product features for role restriction

Parameters:
  • view – AddRoleView or EditRoleView
  • product_features – list of product features with options to select
update(updates)[source]

Update role method

Parameters:updates – role data that should be changed
Note: In case updates is the same as original role data, update will be canceled,
as ‘Save’ button will not be active
class cfme.configure.access_control.RoleAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddRoleView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.RoleAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AllRolesView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.RoleDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsRoleView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.RoleEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditRoleView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.RoleForm(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Role Form for CFME UI

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

product_features_tree

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_restriction_select

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.Tenant(name=None, description=None, parent_tenant=None, _default=False, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Class representing CFME tenants in the UI. * Kudos to mfalesni *

The behaviour is shared with Project, which is the same except it cannot create more nested tenants/projects.

Parameters:
  • name – Name of the tenant
  • description – Description of the tenant
  • parent_tenant – Parent tenant, can be None, can be passed as string or object
create(cancel=False)[source]

Create role method

Parameters:cancel – True - if you want to cancel role creation, by defaul(False), role will be created
delete(cancel=True)[source]

Delete existing role

Parameters:cancel – Default value ‘True’, role will be deleted ‘False’ - deletion of role will be canceled
exists
classmethod get_root_tenant()[source]
parent_path
parent_tenant
pretty_attrs = ['name', 'description']
set_quota(**kwargs)[source]

Sets tenant quotas

tree_path
update(updates)[source]

Update tenant/project method

Parameters:updates – tenant/project data that should be changed
Note: In case updates is the same as original tenant/project data, update will be canceled,
as ‘Save’ button will not be active
class cfme.configure.access_control.TenantAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddTenantView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.TenantAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AllTenantView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.TenantDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsTenantView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.TenantEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditTenantView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.TenantForm(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Tenant Form

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.TenantManageQuotas(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TenantQuotaView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.TenantQuotaView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

Tenant Quota View

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cpu_cb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cpu_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

memory_cb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

memory_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

storage_cb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

storage_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

template_cb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

template_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_cb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.User(name=None, credential=None, email=None, group=None, cost_center=None, value_assign=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Class represents an user in CFME UI

Parameters:
  • name – Name of the user
  • credential – User’s credentials
  • email – User’s email
  • group – User’s group for assigment
  • cost_center – User’s cost center
  • value_assign – user’s value to assign
  • appliance – appliance under test
change_stored_password(changes=None, cancel=False)[source]

Changes user password

Parameters:
  • changes – dict with fields to be changes, if None, passwords fields only be anabled
  • cancel – True, if you want to disable password change
copy()[source]

Creates copy of existing user return: User object of copied user

create(cancel=False)[source]

User creation method

Parameters:cancel – True - if you want to cancel user creation, by defaul user will be created
delete(cancel=True)[source]

Delete existing user

Parameters:cancel – Default value ‘True’, user will be deleted ‘False’ - deletion of user will be canceled
description
edit_tags(tag, value)[source]

Edits tag for existing user

Parameters:
  • tag – Tag category
  • value – Tag name
exists
pretty_attrs = ['name', 'group']
remove_tag(tag, value)[source]

Remove tag from existing user

Parameters:
  • tag – Tag category
  • value – Tag name
update(updates)[source]

Update user method

Parameters:updates – user data that should be changed

Note: In case updates is the same as original user data, update will be canceled, as ‘Save’ button will not be active

class cfme.configure.access_control.UserAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddUserView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.UserAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AllUserView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.UserDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsUserView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.UserEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditUserView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.UserForm(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.ConfigurationView

User Form View.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

email_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password_verify_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

user_group_select

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

userid_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.access_control.UserTagsEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditTagsUserView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.access_control.UsersEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.configure.access_control.simple_user(userid, password)[source]
cfme.configure.documentation module
class cfme.configure.documentation.DocView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

View for the documentation page, a title and a bunch of pdf of links

is_displayed

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.documentation.LinksView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Widgets for all of the links on the documentation page Each doc link is an anchor with a child image element, then an anchor with text Both the image and the text anchor should link to the same PDF

automation

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

customer_portal

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

general

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

inventory

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policies

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

providers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

rest

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

scripting

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_hosts

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.configure.settings module
class cfme.configure.settings.DefaultFilter(name=None, filters=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

pretty_attrs = ['name', 'filters']
update(updates)[source]
class cfme.configure.settings.DefaultFilterAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DefaultFilterForm

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.settings.DefaultFilterForm(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.MySettingsView

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tree

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.settings.DefaultView(appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable

classmethod get_default_view(button_group_name, fieldset=None)[source]
look_up = {'Flavors': 'flavors', 'My Services': 'my_services', 'Catalog Items': 'catalog_items', 'Templates & Images': 'templates', 'VMs': 'vms', 'Cloud Providers': 'cloud_providers', 'VMs & Instances': 'vms_instances', 'Compare': 'compare', 'Infrastructure Providers': 'infrastructure_providers', 'Compare Mode': 'compare_mode', 'Instances': 'instances', 'Availability Zones': 'availability_zones', 'Images': 'images'}
classmethod set_default_view(button_group_names, defaults, fieldset=None)[source]

This function sets default views for the objects.

Parameters:
  • button_group_names – either the name of the button_group_name or list of the button groups to set the default view for.
  • default – the default view to set. in case that button_group_names is a list, you can either set 1 view and it’ll be set for all the button_group_names or you can use a list (default view per button_group_name).
class cfme.configure.settings.DefaultViewAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DefaultViewForm

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.settings.DefaultViewForm(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.MySettingsView

availability_zones

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

catalog_items

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cloud_providers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

compare

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

compare_mode

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flavors

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

images

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

infrastructure_providers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

instances

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

my_services

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

templates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vms

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vms_instances

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.settings.TimeProfileAddForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

days

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hours

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_edit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

scope

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

timezone

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.settings.TimeProfileAddFormView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

mysetting

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

timeprofile_form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.settings.Timeprofile(description=None, scope=None, days=None, hours=None, timezone=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable

copy(name=None)[source]
create(cancel=False)[source]
delete()[source]
update(updates)[source]
class cfme.configure.settings.TimeprofileAddEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.configure.settings.TimeprofileAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TimeProfileAddFormView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.settings.Visual(*args, **kwargs)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable

cloud_provider_quad
datastore_quad
grid_view_limit
host_quad
infra_provider_quad
list_view_limit
login_page
report_view_limit
template_quad
tile_view_limit
timezone
vm_quad
class cfme.configure.settings.VisualAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of VisualTabForm

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.configure.settings.VisualTabForm(parent, logger=None, **kwargs)[source]

Bases: cfme.base.ui.MySettingsView

reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

visualdisplay

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

visualitem

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

visualquadicons

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

visualstartpage

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.configure.tasks module

Module dealing with Configure/Tasks section.

class cfme.configure.tasks.AllOtherTasks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TasksView

am_i_here()[source]
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.configure.tasks.AllTasks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TasksView

am_i_here()[source]
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.configure.tasks.MyOtherTasks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TasksView

am_i_here()[source]
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.configure.tasks.MyTasks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TasksView

am_i_here()[source]
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.configure.tasks.Tasks(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

class cfme.configure.tasks.TasksView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

delete

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tabs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.configure.tasks.delete_all_tasks(destination)[source]
cfme.configure.tasks.is_analysis_finished(name, task_type='vm', clear_tasks_after_success=True)[source]

Check if analysis is finished - if not, reload page

cfme.configure.tasks.is_cluster_analysis_finished(name, **kwargs)[source]
cfme.configure.tasks.is_datastore_analysis_finished(name, **kwargs)[source]
cfme.configure.tasks.is_host_analysis_finished(name, **kwargs)[source]
cfme.configure.tasks.is_task_finished(destination, task_name, expected_status, clear_tasks_after_success=True)[source]
cfme.configure.tasks.is_vm_analysis_finished(name, **kwargs)[source]
cfme.configure.tasks.wait_analysis_finished(task_name, task_type, delay=5, timeout='5M')[source]

Wait until analysis is finished (or timeout exceeded)

Module contents
cfme.containers package
Subpackages
cfme.containers.provider package
Submodules
cfme.containers.provider.kubernetes module
class cfme.containers.provider.kubernetes.KubernetesProvider(name=None, credentials=None, key=None, zone=None, hostname=None, port=None, sec_protocol=None, hawkular_sec_protocol=None, provider_data=None, appliance=None)[source]

Bases: cfme.containers.provider.ContainersProvider

db_types = ['Kubernetes::ContainerManager']
static from_config(prov_config, prov_key, appliance=None)[source]
mgmt_class = <Mock name='mock.Kubernetes' id='139657565876944'>
type_name = 'kubernetes'
cfme.containers.provider.openshift module
class cfme.containers.provider.openshift.CustomAttribute(name, value, field_type=None, href=None)[source]

Bases: object

class cfme.containers.provider.openshift.HawkularEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

Represents Hawkular Endpoint

name = 'hawkular'
view_value_mapping
class cfme.containers.provider.openshift.OpenshiftDefaultEndpoint(**kwargs)[source]

Bases: cfme.containers.provider.ContainersProviderDefaultEndpoint

Represents Openshift default endpoint

static get_ca_cert()[source]

Getting OpenShift’s certificate from the master machine. :param No args.:

Returns:certificate’s content.
class cfme.containers.provider.openshift.OpenshiftProvider(name=None, key=None, zone=None, provider_data=None, endpoints=None, appliance=None)[source]

Bases: cfme.containers.provider.ContainersProvider

STATS_TO_MATCH = ['num_project', 'num_service', 'num_replication_controller', 'num_pod', 'num_node', 'num_image_registry', 'num_container', 'num_route']
add_custom_attributes(*custom_attributes)[source]

Adding static custom attributes to provider. :param custom_attributes: The custom attributes to add.

returns: response.

cli
custom_attributes()[source]

returns custom attributes

db_types = ['Openshift::ContainerManager']
delete_custom_attributes(*custom_attributes)[source]

Deleting static custom attributes from provider.

Parameters:custom_attributes – The custom attributes to delete. (Could be also names (str))

Returns: response.

edit_custom_attributes(*custom_attributes)[source]

Editing static custom attributes in provider. :param custom_attributes: The custom attributes to edit.

returns: response.

endpoints_form

alias of ContainersProviderEndpointsForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]
href()[source]
mgmt_class = <Mock name='mock.Openshift' id='139657577650640'>
num_route(*args, **kwargs)
num_route_ui = None
num_template(*args, **kwargs)
num_template_ui = None
type_name = 'openshift'
view_value_mapping
Module contents
class cfme.containers.provider.AdHocMain(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AdHocMetricsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.provider.AdHocMetricsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

apply_btn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

apply_filter()[source]
filter_dropdown

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

filter_result_header

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

get_random_filter()[source]
get_total_results_count()[source]
is_displayed
selected_filter = None
set_filter(desired_filter)[source]
wait_for_filter_option_to_load()[source]
wait_for_results_to_load()[source]
class cfme.containers.provider.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ContainersProviderAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.provider.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ContainersProvidersView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.provider.ContainerObjectAllBaseView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider_views.ProvidersView

Base class for container object All view. TITLE_TEXT should be defined in child.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities
is_displayed
policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table
title()[source]
class cfme.containers.provider.ContainersProvider(name=None, key=None, zone=None, endpoints=None, provider_data=None, appliance=None)[source]

Bases: cfme.common.provider.BaseProvider, utils.pretty.Pretty

PLURAL = 'Providers'
STATS_TO_MATCH = ['num_project', 'num_service', 'num_replication_controller', 'num_pod', 'num_node', 'num_image_registry', 'num_container']
category = 'container'
db_types = ['ContainerManager']
detail_page_suffix = 'provider_detail'
edit_page_suffix = 'provider_edit_detail'
endpoints_form

alias of ContainersProviderEndpointsForm

get_detail(*ident)[source]

Gets details from the details infoblock

Parameters:*ident – An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

in_version = ('5.5', Version('master'))
load_details(refresh=False)[source]
num_container(*args, **kwargs)
num_container_group(*args, **kwargs)
num_container_group_ui = None
num_container_ui = None
num_image(*args, **kwargs)
num_image_registry(*args, **kwargs)
num_image_registry_ui = None
num_image_ui = None
num_node(*args, **kwargs)
num_node_ui = None
num_pod(*args, **kwargs)
num_pod_ui = None
num_project(*args, **kwargs)
num_project_ui = None
num_replication_controller(*args, **kwargs)
num_replication_controller_ui = None
num_service(*args, **kwargs)
num_service_ui = None
page_name = 'containers'
pods_per_ready_status()[source]

Grabing the Container Statuses Summary of the pods from API

pretty_attrs = ['name', 'key', 'zone']
provider_types = {}
quad_name = None
string_name = 'Containers'
view_value_mapping
class cfme.containers.provider.ContainersProviderDefaultEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

Represents Containers Provider default endpoint

credential_class

alias of TokenCredential

view_value_mapping
class cfme.containers.provider.ContainersProviderEndpointsForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents default Containers Provider endpoint form in UI (Add/Edit dialogs)

default

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hawkular

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.containers.provider.ContainersTestItem(obj, polarion_id, **additional_attrs)[source]

Bases: object

This is a generic test item. Especially used for parametrized functions

classmethod get_pretty_id(obj)[source]

Since sometimes the test object is wrapped within markers, it’s difficult to find get it inside the args tree. hence we use this to get the object and all pretty_id function.

Parameters:obj (*) – Either a ContainersTestItem or a marker that include it
Returns:str pretty id
pretty_id()[source]
class cfme.containers.provider.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProviderDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.provider.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ContainersProviderEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.provider.EditFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.provider.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.provider.EditTagsFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.provider.Labelable[source]

Bases: object

Provide the functionality to set labels

get_labels()[source]

List labels

remove_label(name, silent_failure=False)[source]

Remove label by name. :param name: name of label :param silent_failure: whether to raise an error or not in case of failure.

Returns: bool pass or fail

Raises:LabelNotFoundException.
set_label(name, value)[source]

Sets a label to the object instance

:param : var name: the name of the label :param : var value: the value of the label

Returns:self.mgmt.set_label return value.
class cfme.containers.provider.LoggingableView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

get_logging_url()[source]
monitor

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.containers.provider.ProviderDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage, cfme.containers.provider.LoggingableView

is_displayed
class cfme.containers.provider.TimelinesFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.provider.TopologyFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.containers.provider.navigate_and_get_rows(provider, obj, count, silent_failure=False)[source]

Get <count> random rows from the obj list table, if <count> is greater that the number of rows, return number of rows.

Parameters:
  • provider – containers provider
  • obj – the containers object
  • table – the object’s Table object
  • count – number of random rows to return
  • silent_failure – If True and no records found for obj, it’ll return None instead of raise exception

return: list of rows

Submodules
cfme.containers.container module
class cfme.containers.container.Container(name, pod, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Containers'
click_element(*ident)[source]
get_detail(*ident)[source]

Gets details from the details infoblock :param *ident: An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
project_name
class cfme.containers.container.ContainerAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ContainerAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.container.ContainerAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Containers All view

Filters

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

containers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
summary

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table
class cfme.containers.container.ContainerDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.container.ContainerEditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.container.ContainerTimeLines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.container.ContainerUtilization(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.containers.image module
class cfme.containers.image.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ImageAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.image.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.image.Image(name, image_id, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.containers.provider.Labelable, cfme.common.SummaryMixin, utils.appliance.Navigatable, cfme.common.PolicyProfileAssignable

PLURAL = 'Container Images'
check_compliance(wait_for_finish=True, timeout=240)[source]

Initiates compliance check and waits for it to finish.

compliance_status
compliant

Check if the image is compliant

Returns:NoneType if the image was never verified, otherwise bool
get_detail(*ident)[source]

Gets details from the details infoblock :param *ident: Table name and Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the summary’s value.

classmethod get_random_instances(provider, count=1, appliance=None, docker_only=False)[source]

Generating random instances. (docker_only: means for docker images only)

load_details(refresh=False)[source]
mgmt
perform_smartstate_analysis(wait_for_finish=False, timeout='7M')[source]

Performing SmartState Analysis on this Image

sha256
class cfme.containers.image.ImageAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Container Images'
configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities
cfme.containers.image_registry module
class cfme.containers.image_registry.ImageRegistry(host, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Image Registries'
classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
name
class cfme.containers.image_registry.ImageRegistryAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ImageRegistryAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.image_registry.ImageRegistryAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Image Registries'
entities
class cfme.containers.image_registry.ImageRegistryDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.image_registry.ImageRegistryEditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.containers.node module
class cfme.containers.node.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NodeAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step(*args, **kwargs)[source]
class cfme.containers.node.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NodeDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.containers.node.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NodeEditTagsForm

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.node.ManagePolicies(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NodeManagePoliciesForm

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.node.Node(name, provider, collection=None, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.containers.provider.Labelable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Nodes'
get_detail(*ident)[source]

Gets details from the details infoblock :param *ident: Table name and Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the summary’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
class cfme.containers.node.NodeAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.node.NodeView

entities
is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
class cfme.containers.node.NodeCollection(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

Collection object for Node.

all()[source]
instantiate(name, provider)[source]
class cfme.containers.node.NodeDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.node.NodeView

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities
is_displayed
properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.containers.node.NodeEditTagsForm(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.node.NodeView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag_category

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.containers.node.NodeManagePoliciesForm(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.node.NodeView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy_profiles

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.containers.node.NodeTimelinesForm(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.node.NodeView

entities
is_displayed
class cfme.containers.node.NodeUtilizationView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.node.NodeView

entities
is_displayed
class cfme.containers.node.NodeView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView, cfme.containers.provider.LoggingableView

TITLE_TEXT = 'Nodes'
entities
in_cloud_instance
nodes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table
class cfme.containers.node.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NodeTimelinesForm

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.node.Utilization(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NodeUtilizationView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.containers.overview module
class cfme.containers.overview.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.overview.ContainersOverview(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

cfme.containers.pod module
class cfme.containers.pod.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PodAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.pod.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.pod.Pod(name, project_name, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.containers.provider.Labelable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Pods'
click_element(*ident)[source]
get_detail(*ident)[source]

Gets details from the details infoblock

Parameters:*ident – An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
class cfme.containers.pod.PodAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Pods'
entities
cfme.containers.project module
class cfme.containers.project.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProjectAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.project.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.project.Project(name, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.containers.provider.Labelable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Projects'
click_element(*ident)[source]
get_detail(*ident)[source]

Gets details from the details infoblock :param *ident: An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
class cfme.containers.project.ProjectAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Projects'
entities
cfme.containers.replicator module
class cfme.containers.replicator.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ReplicatorAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.replicator.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.replicator.Replicator(name, project_name, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.containers.provider.Labelable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Replicators'
click_element(*ident)[source]
get_detail(*ident)[source]

Gets details from the details infoblock

Parameters:*ident – An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
class cfme.containers.replicator.ReplicatorAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Replicators'
entities
cfme.containers.route module
class cfme.containers.route.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RouteAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.route.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.route.Route(name, project_name, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.containers.provider.Labelable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Routes'
click_element(*ident)[source]
get_detail(*ident)[source]

Gets details from the details infoblock :param *ident: An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
class cfme.containers.route.RouteAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Routes'
entities
cfme.containers.service module
class cfme.containers.service.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServiceAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.service.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.service.Service(name, project_name, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.containers.provider.Labelable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Container Services'
click_element(*ident)[source]
get_detail(*ident)[source]

Gets details from the details infoblock :param *ident: An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
class cfme.containers.service.ServiceAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Container Services'
entities
cfme.containers.template module
class cfme.containers.template.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TemplateAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.template.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.template.Template(name, project_name, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.containers.provider.Labelable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Templates'
click_element(*ident)[source]
get_detail(*ident)[source]

Gets details from the details infoblock

Parameters:*ident – An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
class cfme.containers.template.TemplateAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Container Templates'
entities
cfme.containers.topology module
class cfme.containers.topology.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.topology.Topology(appliance=None)[source]

Bases: cfme.common.TopologyMixin, utils.appliance.Navigatable

classmethod load_topology_page()[source]
cfme.containers.volume module
class cfme.containers.volume.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of VolumeAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.containers.volume.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.containers.volume.Volume(name, provider, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.common.SummaryMixin, utils.appliance.Navigatable

PLURAL = 'Volumes'
get_detail(*ident)[source]

Gets details from the details infoblock :param *ident: Table name and Key name, e.g. “Relationships”, “Volumes”

Returns: A string representing the contents of the summary’s value.

classmethod get_random_instances(provider, count=1, appliance=None)[source]

Generating random instances.

load_details(refresh=False)[source]
mgmt
class cfme.containers.volume.VolumeAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.containers.provider.ContainerObjectAllBaseView

TITLE_TEXT = 'Persistent Volumes'
entities
Module contents
cfme.control package
Subpackages
cfme.control.explorer package
Submodules
cfme.control.explorer.actions module

Page model for Control / Explorer

class cfme.control.explorer.actions.Action(description, action_type, action_values=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable, utils.pretty.Pretty

This class represents one Action.

Example

>>> from cfme.control.explorer import Action
>>> action = Action("some_action",
...     action_type="Tag",
...     action_values={"tag": ("My Company Tags", "Service Level", "Gold")}
>>> action.create()
>>> action.delete()
Parameters:
  • description – Action name.
  • action_type – Type of the action, value from the dropdown select.
alerts_to_evaluate
create()[source]

Create this Action in UI.

delete(cancel=False)[source]

Delete this Action in UI.

Parameters:cancel – Whether to cancel the deletion (default False).
delete_if_exists()[source]
exists

Check existence of this Action.

Returns: bool signalizing the presence of the Action in the database.

update(updates)[source]

Update this Action in UI.

Parameters:
  • updates – Provided by update() context manager.
  • cancel – Whether to cancel the update (default False).
class cfme.control.explorer.actions.ActionDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ActionDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.actions.ActionDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

analysis_profile

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.actions.ActionEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditActionView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.actions.ActionFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

action_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

alerts_to_evaluate

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

analysis_profile

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cpu_number

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

email_recipient

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

email_sender

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

memory_amount

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

parent_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

remove_tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

run_ansible_playbook

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

snapshot_age

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

snapshot_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
vcenter_attr_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vcenter_attr_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.actions.ActionNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewActionView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.actions.ActionsAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.actions.EditActionView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.actions.ActionFormCommon

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.actions.NewActionView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.actions.ActionFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.actions.RunAnsiblePlaybookFromView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

inventory

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

playbook_catalog_item

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.control.explorer.alert_profiles module
class cfme.control.explorer.alert_profiles.AlertProfileDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AlertProfileDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.alert_profiles.AlertProfileDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alert_profiles.AlertProfileEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditAlertProfileView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.alert_profiles.AlertProfileEditAssignments(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AlertProfilesEditAssignmentsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.alert_profiles.AlertProfileFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

alerts

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

notes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alert_profiles.AlertProfileNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewAlertProfileView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.alert_profiles.AlertProfilesAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alert_profiles.AlertProfilesEditAssignmentsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

assign_to

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

based_on

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

header

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

selections

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
tag_category

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alert_profiles.BaseAlertProfile(description, alerts=None, notes=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable, utils.pretty.Pretty

TYPE = None
assign_to(assign, selections=None, tag_category=None)[source]

Assigns this Alert Profile to specified objects.

Parameters:
  • assign – Where to assign (The Enterprise, ...).
  • selections – What items to check in the tree. N/A for The Enteprise.
  • tag_category – Only for choices starting with Tagged. N/A for The Enterprise.
create()[source]
delete(cancel=False)[source]

Delete this Alert Profile in UI.

Parameters:cancel – Whether to cancel the deletion (default False).
exists

Check existence of this Alert Profile.

Returns: bool signalizing the presence of the Alert Profile in database.

pretty_attrs = ['description', 'alerts']
update(updates)[source]

Update this Alert Profile in UI.

Parameters:
  • updates – Provided by update() context manager.
  • cancel – Whether to cancel the update (default False).
class cfme.control.explorer.alert_profiles.ClusterAlertProfile(description, alerts=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.alert_profiles.BaseAlertProfile

TYPE = 'Cluster / Deployment Role'
class cfme.control.explorer.alert_profiles.DatastoreAlertProfile(description, alerts=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.alert_profiles.BaseAlertProfile

TYPE = 'Datastore'
class cfme.control.explorer.alert_profiles.EditAlertProfileView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.alert_profiles.AlertProfileFormCommon

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alert_profiles.HostAlertProfile(description, alerts=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.alert_profiles.BaseAlertProfile

TYPE = 'Host / Node'
class cfme.control.explorer.alert_profiles.MiddlewareServerAlertProfile(description, alerts=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.alert_profiles.BaseAlertProfile

TYPE = 'Middleware Server'
class cfme.control.explorer.alert_profiles.NewAlertProfileView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.alert_profiles.AlertProfileFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.control.explorer.alert_profiles.ProviderAlertProfile(description, alerts=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.alert_profiles.BaseAlertProfile

TYPE = 'Provider'
class cfme.control.explorer.alert_profiles.ServerAlertProfile(description, alerts=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.alert_profiles.BaseAlertProfile

TYPE = 'Server'
class cfme.control.explorer.alert_profiles.VMInstanceAlertProfile(description, alerts=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.alert_profiles.BaseAlertProfile

TYPE = 'VM and Instance'
cfme.control.explorer.alerts module

Page model for Control / Explorer

class cfme.control.explorer.alerts.Alert(description, active=None, based_on=None, evaluate=None, driving_event=None, notification_frequency=None, snmp_trap=None, emails=None, timeline_event=None, mgmt_event=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable, utils.pretty.Pretty

Alert representation object. .. rubric:: Example

>>> alert = Alert("my_alert", timeline_event=True, driving_event="Hourly Timer")
>>> alert.create()
>>> alert.delete()
Parameters:
  • description – Name of the Alert.
  • based_on – Cluster, Datastore, Host, Provider, ...
  • evaluate –

    Use it as follows: ("What to Evaluate selection", dict(values="for form")). If you want to select Nothing, you will therefore pass ("Nothing", {}). Other example:

    ("Hardware Reconfigured",
 dict(hw_attribute="Number of CPUs", hw_attribute_operator="Increased")
)
  • driving_event – This Alert’s driving event (Hourly Timer, ...).
  • notification_frequency – 1 Minute, 2 Minutes, ...
  • snmp_trap – Whether to send snmp traps.
  • emails – Whether to send e-mails. False disables, string or list of strings with emails enables.
  • timeline_event – Whether generate a timeline event.
  • mgmt_event – If specified as string, it will reveal the form and types it into the text box. If False, then it will be disabled. None - don’t care.
__str__()[source]

Conversion to string used when assigning in multibox selector.

copy(**updates)[source]

Copy this Alert in UI.

Parameters:updates – updates for the alert.
create()[source]

Create this Alert in UI.

delete(cancel=False)[source]

Delete this Alert in UI.

Parameters:cancel – Whether to cancel the deletion (default False).
exists

Check existence of this Alert.

Returns: bool signalizing the presence of the Alert in the database.

pretty_attrs = ['description', 'evaluate']
update(updates, cancel=False)[source]

Update this Alert in UI.

Parameters:
  • updates – Provided by update() context manager.
  • cancel – Whether to cancel the update (default False).
class cfme.control.explorer.alerts.AlertCopy(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewAlertView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.alerts.AlertDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AlertDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.alerts.AlertDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alerts.AlertEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditAlertView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.alerts.AlertFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

active

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

based_on

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

driving_event

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

emails

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

emails_send

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

evaluate

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

mgmt_event

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

mgmt_event_send

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

notification_frequency

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

snmp_trap

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

snmp_trap_send

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

timeline_event

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alerts.AlertNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewAlertView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.alerts.AlertsAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alerts.EditAlertView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.alerts.AlertFormCommon

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.alerts.NewAlertView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.alerts.AlertFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.control.explorer.conditions module
class cfme.control.explorer.conditions.BaseCondition(description, expression=None, scope=None, notes=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable, utils.pretty.Pretty

FIELD_VALUE = None
PRETTY = None
TREE_NODE = None
create()[source]
delete(cancel=False)[source]

Delete this Condition in UI.

Parameters:cancel – Whether to cancel the deletion (default False).
exists

Check existence of this Condition.

Returns: bool signalizing the presence of the Condition in the database.

read_expression()[source]
read_scope()[source]
update(updates)[source]

Update this Condition in UI.

Parameters:
  • updates – Provided by update() context manager.
  • cancel – Whether to cancel the update (default False).
class cfme.control.explorer.conditions.ConditionDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ConditionDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.conditions.ConditionDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

expression

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
scope

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.conditions.ConditionEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditConditionView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.conditions.ConditionFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

expression

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

notes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

scope

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.conditions.ConditionNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewConditionView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.conditions.ConditionsAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.conditions.ContainerImageCondition(description, expression=None, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.conditions.BaseCondition

FIELD_VALUE = 'Container Image'
PRETTY = 'Container Image'
TREE_NODE = 'Container Image'
class cfme.control.explorer.conditions.ContainerNodeCondition(description, expression=None, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.conditions.BaseCondition

FIELD_VALUE = 'Node'
PRETTY = 'Node'
TREE_NODE = 'Container Node'
class cfme.control.explorer.conditions.EditConditionView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.conditions.ConditionFormCommon

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.conditions.Expression(parent, type_, logger=None)[source]

Bases: widgetastic.widget.Widget

ROOT = 'div#condition_info_div'
read(*args, **kwargs)[source]

In Condition details view Scope and Expression don’t have any locator. So we have to scrape whole text in the parent div and split it by “n”. After that in text_list we receive something like that:

[u'Scope',
 u'COUNT OF VM and Instance.Files > 150',
 u'Expression',
 u'VM and Instance : Boot Time BEFORE "03/04/2014 00:00"',
 u'Notes',
 u'No notes have been entered.',
 u'Assigned to Policies',
 u'This Condition is not assigned to any Policies.']

To get value of Scope or Expression firstly we find its index in the list and then just seek next member.

text_list
class cfme.control.explorer.conditions.HostCondition(description, expression=None, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.conditions.BaseCondition

FIELD_VALUE = 'Host / Node'
PRETTY = 'Host / Node'
TREE_NODE = 'Host'
class cfme.control.explorer.conditions.NewConditionView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.conditions.ConditionFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.control.explorer.conditions.PodCondition(description, expression=None, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.conditions.BaseCondition

FIELD_VALUE = 'Pod'
PRETTY = 'Pod'
TREE_NODE = 'Pod'
class cfme.control.explorer.conditions.ProviderCondition(description, expression=None, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.conditions.BaseCondition

FIELD_VALUE = 'Provider'
PRETTY = 'Provider'
TREE_NODE = 'Provider'
class cfme.control.explorer.conditions.ReplicatorCondition(description, expression=None, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.conditions.BaseCondition

FIELD_VALUE = 'Replicator'
PRETTY = 'Replicator'
TREE_NODE = 'Replicator'
class cfme.control.explorer.conditions.VMCondition(description, expression=None, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.conditions.BaseCondition

FIELD_VALUE = 'VM and Instance'
PRETTY = 'VM'
TREE_NODE = 'VM and Instance'
cfme.control.explorer.policies module

Page model for Control / Explorer

class cfme.control.explorer.policies.BasePolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable, utils.pretty.Pretty

This class represents a Policy.

Example

>>> from cfme.control.explorer.policy import VMCompliancePolicy
>>> policy = VMCompliancePolicy("policy_description")
>>> policy.create()
>>> policy.delete()
Parameters:
  • description – Policy name.
  • active – Whether the policy active or not.
  • scope – Policy scope.
  • notes – Policy notes.
PRETTY = None
TREE_NODE = None
TYPE = None
assign_actions_to_event(event, actions)[source]

This method takes a list or dict of actions, goes into the policy event and assigns them. Actions can be passed both as the objects, but they can be passed also as a string. Actions, passed as an object but not created yet, will be created. If the specified event is not assigned to the policy, it will be assigned.

Parameters:
  • event – Name of the event under which the actions will be assigned.
  • actions – If list (or similar), all of these actions will be set under TRUE section. If dict, the action is key and value specifies its placement. If it’s True, then it will be put in the TRUE section and so on.
assign_conditions(*conditions)[source]

Assign conditions to this Policy.

Parameters:conditions – Conditions which need to be assigned.
assign_events(*events, **kwargs)[source]

Assign events to this Policy.

Parameters:
  • events – Events which need to be assigned.
  • extend – Do not uncheck existing events.
assigned_events
copy(cancel=False)[source]

Copy this Policy in UI.

Parameters:cancel – Whether to cancel the copying (default False).
create()[source]

Create this Policy in UI.

delete(cancel=False)[source]

Delete this Policy in UI.

Parameters:cancel – Whether to cancel the deletion (default False).
exists
is_condition_assigned(condition)[source]
is_event_assigned(event)[source]
update(updates)[source]

Update this Policy in UI.

Parameters:
  • updates – Provided by update() context manager.
  • cancel – Whether to cancel the update (default False).
class cfme.control.explorer.policies.ConditionDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.ContainerImageCompliancePolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Container Image'
TREE_NODE = 'Container Image'
TYPE = 'Compliance'
class cfme.control.explorer.policies.ContainerImageControlPolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Container Image'
TREE_NODE = 'Container Image'
TYPE = 'Control'
class cfme.control.explorer.policies.ContainerNodeCompliancePolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Node'
TREE_NODE = 'Container Node'
TYPE = 'Compliance'
class cfme.control.explorer.policies.ContainerNodeControlPolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Node'
TREE_NODE = 'Container Node'
TYPE = 'Control'
class cfme.control.explorer.policies.EditEventView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

false_actions

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

true_actions

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.EditPolicyConditionAssignments(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

conditions

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.EditPolicyEventAssignments(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

events

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.EditPolicyView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.policies.PolicyFormCommon

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.EventDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.HostCompliancePolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Host / Node'
TREE_NODE = 'Host'
TYPE = 'Compliance'
class cfme.control.explorer.policies.HostControlPolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Host / Node'
TREE_NODE = 'Host'
TYPE = 'Control'
class cfme.control.explorer.policies.NewPolicyView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.policies.PolicyFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.PodCompliancePolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Pod'
TREE_NODE = 'Pod'
TYPE = 'Compliance'
class cfme.control.explorer.policies.PodControlPolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Pod'
TREE_NODE = 'Pod'
TYPE = 'Control'
class cfme.control.explorer.policies.PoliciesAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.PolicyConditionDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ConditionDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.policies.PolicyDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PolicyDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.policies.PolicyDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

analysis_profile

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.PolicyEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditPolicyView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.policies.PolicyEventDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EventDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.policies.PolicyFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

active

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

notes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

scope

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policies.PolicyNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewPolicyView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.policies.ReplicatorCompliancePolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Replicator'
TREE_NODE = 'Replicator'
TYPE = 'Compliance'
class cfme.control.explorer.policies.ReplicatorControlPolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'Replicator'
TREE_NODE = 'Replicator'
TYPE = 'Control'
class cfme.control.explorer.policies.VMCompliancePolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'VM and Instance'
TREE_NODE = 'Vm'
TYPE = 'Compliance'
class cfme.control.explorer.policies.VMControlPolicy(description, active=True, scope=None, notes=None, appliance=None)[source]

Bases: cfme.control.explorer.policies.BasePolicy

PRETTY = 'VM and Instance'
TREE_NODE = 'Vm'
TYPE = 'Control'
cfme.control.explorer.policy_profiles module
class cfme.control.explorer.policy_profiles.EditPolicyProfileView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.policy_profiles.PolicyProfileFormCommon

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policy_profiles.NewPolicyProfileView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.policy_profiles.PolicyProfileFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.control.explorer.policy_profiles.PolicyProfile(description, policies=None, notes=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable, utils.pretty.Pretty

create()[source]
delete(cancel=False)[source]

Delete this Policy Profile in UI.

Parameters:cancel – Whether to cancel the deletion (default False).
exists

Check existence of this Policy Profile.

Returns: bool signalizing the presence of the Policy Profile in database.

prepared_policies
update(updates)[source]

Update this Policy Profile in UI.

Parameters:
  • updates – Provided by update() context manager.
  • cancel – Whether to cancel the update (default False).
class cfme.control.explorer.policy_profiles.PolicyProfileDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PolicyProfileDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.policy_profiles.PolicyProfileDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policy_profiles.PolicyProfileEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditPolicyProfileView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.policy_profiles.PolicyProfileFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

notes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policies

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.explorer.policy_profiles.PolicyProfileNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewPolicyProfileView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.policy_profiles.PolicyProfilesAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.control.explorer.ControlExplorerView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents
class cfme.control.explorer.ControlExplorer(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ControlExplorerView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.explorer.ControlExplorerView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

actions

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

alert_profiles

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

alerts

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

conditions

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

events

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_control_explorer
is_displayed
policies

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy_profiles

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Submodules
cfme.control.import_export module
class cfme.control.import_export.ControlImportExport(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ControlImportExportView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.import_export.ControlImportExportView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

commit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

export

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

export_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
policy_profiles

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

upload_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

upload_file

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.control.import_export.InputButton(parent, name=None, id=None, locator=None, logger=None)[source]

Bases: widgetastic_patternfly.Input, widgetastic.widget.ClickableMixin

cfme.control.import_export.import_file(filename, cancel=False)[source]

Go to Control / Import Export and import given file.

Parameters:
  • filename – Full path to file to import.
  • cancel – Whether to click Cancel instead of commit.
cfme.control.import_export.is_imported(policy_profile)[source]
cfme.control.log module
class cfme.control.log.ControlLog(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ControlLogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.log.ControlLogView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Basic view for Control/Log tab.

download_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
refresh_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

subtitle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.control.simulation module
class cfme.control.simulation.ControlSimulation(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ControlSimulationView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.control.simulation.ControlSimulationView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Basic view for Control/Simulation tab.

event_selection

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

submit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_selection

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.control.snmp_form module

This file contains useful classes for working with SNMP filling.

class cfme.control.snmp_form.SNMPForm[source]

Bases: object

Class encapsulating the most common (and hopefully single) configuration of SNMP form

Usage:

form = SNMPForm()
fill(form, dict(
    hosts=["host1", "host2"],
    traps=[
        ("aaa", "Counter32", 125),                      # Takes 3-tuples
        ("bbb", "Null"),                                # 2-tuples with no value specified
        SNMPTrap("ccc", "Gauge32", 256),                # objects dtto
        SNMPTrap("ddd", "Null"),                        # value can be unspecified too
        {"oid": "eee", "type": "Integer", "value": 42}  # omg dict too! Yay.
    ],
    version="v2",
    id="aabcd",
))
fields = <cfme.web_ui.Form fields=[('hosts', <cfme.control.snmp_form.SNMPHostsField object at 0x7f048fd08b50>), ('version', Select("//select[@id='snmp_version']", multi=False)), ('id', <cfme.web_ui.Input _names=('trap_id',), _use_id=False>), ('traps', <cfme.control.snmp_form.SNMPTrapsField num_fields=None>)]>
class cfme.control.snmp_form.SNMPHostsField[source]

Bases: object

Class designed for handling the two-type snmp hosts field.

They can be 3 or just single.

host_fields

Returns list of locators to all host fields

class cfme.control.snmp_form.SNMPTrap(oid, type, value=None)[source]

Bases: utils.pretty.Pretty

Nicer representation of the single SNMP trap

Parameters:
  • oid – SNMP OID
  • type – SNMP type
  • value – Value (default: None)
as_tuple

Return the contents as a tuple used for filling

pretty_attrs = ['oid', 'type', 'value']
class cfme.control.snmp_form.SNMPTrapField(seq_id)[source]

Bases: utils.pretty.Pretty

Class representing SNMP trap field consisting of 3 elements - oid, type and value

Parameters:seq_id – Sequential id of the field. Usually in range 1-10
oid
oid_loc
pretty_attrs = ['seq_id']
type
type_loc
value
value_loc
class cfme.control.snmp_form.SNMPTrapsField(num_fields)[source]

Bases: utils.pretty.Pretty

Encapsulates all trap fields to simplify form filling

Parameters:num_fields – How many SNMPTrapField to generate
pretty_attrs = ['num_fields']
cfme.control.snmp_form.fill_snmp_form(form, values, *rest, **kwrest)[source]

I wanted to use dict but that is overrided in web_ui that it disassembles dict to list of tuples :(

cfme.control.snmp_form.fill_snmp_hosts_field_basestr(field, value)[source]
cfme.control.snmp_form.fill_snmp_hosts_field_list(field, values)[source]
cfme.control.snmp_form.fill_snmp_trap_field_dict(field, val)[source]
cfme.control.snmp_form.fill_snmp_trap_field_trap(field, val)[source]
cfme.control.snmp_form.fill_snmp_trap_field_tuple(field, val)[source]
cfme.control.snmp_form.fill_snmp_traps_field_list(field, values)[source]
cfme.control.snmp_form.fill_snmp_traps_field_single_trap(field, value)[source]
Module contents
cfme.fixtures package
Submodules
cfme.fixtures.base module
cfme.fixtures.base.appliance()[source]
cfme.fixtures.base.ensure_websocket_role_disabled()[source]
cfme.fixtures.base.fix_merkyl_workaround(request, appliance)[source]

Workaround around merkyl not opening an iptables port for communication

cfme.fixtures.base.fix_missing_hostname(appliance)[source]

Fix for hostname missing from the /etc/hosts file

Note: Affects RHOS-based appliances but can’t hurt the others so
it’s applied on all.
cfme.fixtures.base.set_session_timeout(appliance)[source]
cfme.fixtures.cli module
class cfme.fixtures.cli.TimedCommand(command, timeout)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

command

Alias for field number 0

timeout

Alias for field number 1

cfme.fixtures.cli.app_creds()[source]
cfme.fixtures.cli.app_creds_modscope()[source]
cfme.fixtures.cli.dedicated_db_appliance(app_creds, appliance)[source]

‘ap’ launch appliance_console, ‘’ clear info screen, ‘5/8’ setup db, ‘1’ Creates v2_key, ‘1’ selects internal db, ‘y’ continue, ‘1’ use partition, ‘y’ create dedicated db, ‘pwd’ db password, ‘pwd’ confirm db password + wait 360 secs and ‘’ finish.

cfme.fixtures.cli.fqdn_appliance(appliance)[source]
cfme.fixtures.cli.ipa_creds()[source]
cfme.fixtures.cli.ipa_crud(fqdn_appliance, app_creds, ipa_creds)[source]
cfme.fixtures.configure_auth_mode module
cfme.fixtures.configure_auth_mode.available_auth_modes()[source]
cfme.fixtures.configure_auth_mode.configure_auth(request, auth_mode)[source]
cfme.fixtures.configure_auth_mode.configure_aws_iam_auth_mode(browser, available_auth_modes)[source]

Configure AWS IAM authentication mode

cfme.fixtures.configure_auth_mode.configure_ldap_auth_mode(browser, available_auth_modes)[source]

Configure LDAP authentication mode

cfme.fixtures.configure_auth_mode.configure_openldap_auth_mode(browser, available_auth_modes)[source]

Configure LDAP authentication mode

cfme.fixtures.configure_auth_mode.configure_openldap_auth_mode_default_groups(browser, available_auth_modes)[source]

Configure LDAP authentication mode

cfme.fixtures.model_collections module
cfme.fixtures.model_collections.dashboards(appliance)[source]
cfme.fixtures.pytest_selenium module

Provides a number of useful functions for integrating with selenium.

The aim is that no direct calls to selenium be made at all. One reason for this it to ensure that all function calls to selenium wait for the ajax response which is needed in CFME.

Members of this module are available in the the pytest.sel namespace, e.g.:

pytest.sel.click(locator)
var ajax_wait_js:
 A Javascript function for ajax wait checking
var class_selector:
 Regular expression to detect simple CSS locators
class cfme.fixtures.pytest_selenium.ByText(text)[source]

Bases: utils.pretty.Pretty

pretty_attrs = ['text']
class cfme.fixtures.pytest_selenium.ByValue(value)[source]

Bases: utils.pretty.Pretty

pretty_attrs = ['value']
class cfme.fixtures.pytest_selenium.ContextWrapper[source]

Bases: dict

Dict that provides .attribute access + dumps all keys when not found.

cfme.fixtures.pytest_selenium.ScreenShot

alias of screenshot

class cfme.fixtures.pytest_selenium.Select(loc, multi=False, none=None)[source]

Bases: selenium.webdriver.support.select.Select, utils.pretty.Pretty

A proxy class for the real selenium Select() object.

We differ in one important point, that we can instantiate the object without it being present on the page. The object is located at the beginning of each function call.

Can hadle patternfly selectpicker kind of select. It alters the behaviour slightly, it does not use move_to_element() and uses JavaScript more extensively.

Parameters:loc – A locator.

Returns: A cfme.web_ui.Select object.

class Option(text, value)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

text

Alias for field number 0

value

Alias for field number 1

Select.all_options

Returns a list of tuples of all the options in the Select

Select.all_selected_options

Fast variant of the original all_selected_options.

Selenium’s all_selected_options iterates over ALL of the options, this directly returns only those that are selected.

Select.classes
Select.deselect_all()[source]

Fast variant of the original deselect_all.

Uses all_selected_options, mimics selenium’s exception behaviour.

Select.first_selected_option

Fast variant of the original first_selected_option.

Uses all_selected_options, mimics selenium’s exception behaviour.

Select.first_selected_option_text
Select.get_value_by_text(text)[source]
Select.is_broken = False
Select.is_patternfly
Select.locate()[source]

Guards against passing wrong locator (not resolving to a select).

Select.none
Select.observer_wait()[source]
Select.pretty_attrs = ['_loc', 'is_multiple']
Select.select_by_value(value)[source]
Select.select_by_visible_text(text)[source]

Dump all of the options if the required option is not present.

cfme.fixtures.pytest_selenium.ajax_timeout(*args, **kwds)[source]

Change the AJAX timeout in this context. Useful when something takes a long time.

Parameters:seconds – Numebr of seconnds to wait.
cfme.fixtures.pytest_selenium.base_url()[source]

Returns the base url.

Returns: base_url from env config yaml

cfme.fixtures.pytest_selenium.check(loc)[source]

Convenience function to check a checkbox

Parameters:loc – The locator of the element
cfme.fixtures.pytest_selenium.checkbox(loc, set_to=False)[source]

Checks or unchecks a given checkbox

Finds an element given by loc and checks it

Parameters:
  • loc – The locator of the element
  • value – The value the checkbox should represent as a bool (or None to do nothing)

Returns: Previous state of the checkbox

cfme.fixtures.pytest_selenium.classes(loc)[source]

Return a list of classes attached to the element.

cfme.fixtures.pytest_selenium.click(loc, wait_ajax=True, no_custom_handler=False)[source]

Clicks on an element.

If the element implements _custom_click_handler the control will be given to it. Then the handler decides what to do (eg. do not click under some circumstances).

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple or an object implementing _custom_click_handler method.
  • wait_ajax – Whether to wait for ajax call to finish. Default True but sometimes it’s handy to not do that. (some toolbar clicks)
  • no_custom_handler – To prevent recursion, the custom handler sets this to True.
cfme.fixtures.pytest_selenium.current_url()[source]

Returns the current_url of the page

Returns: A url.

cfme.fixtures.pytest_selenium.deselect_by_text(select_element, txt)[source]

Works on a select element and deselects an option by the visible text.

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • text – The select element option’s visible text.
cfme.fixtures.pytest_selenium.deselect_by_value(select_element, val)[source]

Works on a select element and deselects an option by the value attribute.

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • value – The select element’s option value.
cfme.fixtures.pytest_selenium.detect_observed_field(loc)[source]

Detect observed fields; sleep if needed

Used after filling most form fields, this function will inspect the filled field for one of the known CFME observed field attribues, and if found, sleep long enough for the observed field’s AJAX request to go out, and then block until no AJAX requests are in flight.

Observed fields occasionally declare their own wait interval before firing their AJAX request. If found, that interval will be used instead of the default.

cfme.fixtures.pytest_selenium.dismiss_any_alerts()[source]

Loops until there are no further alerts present to dismiss.

Useful for handling the cases where the alert pops up multiple times.

cfme.fixtures.pytest_selenium.double_click(loc, wait_ajax=True)[source]

Double-clicks on an element.

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • wait_ajax – Whether to wait for ajax call to finish. Default True but sometimes it’s handy to not do that. (some toolbar clicks)
cfme.fixtures.pytest_selenium.drag_and_drop(source_element, dest_element)[source]

Drag and Drop element.

Parameters:
  • source_element – A locator, expects either a string, WebElement, tuple.
  • dest_element – A locator, expects either a string, WebElement, tuple.
  • wait_ajax – Whether to wait for ajax call to finish. Default True but sometimes it’s handy to not do that. (some toolbar clicks)
cfme.fixtures.pytest_selenium.drag_and_drop_by_offset(source_element, x=0, y=0)[source]

Drag and Drop element by offset

Parameters:
  • source_element – A locator, expects either a string, WebElement, tuple.
  • x – Distance in pixels on X axis to move it.
  • y – Distance in pixels on Y axis to move it.
cfme.fixtures.pytest_selenium.element(o, **kwargs)[source]

Convert o to a single matching WebElement.

Parameters:o – An object to be converted to a matching web element, expected string, WebElement, tuple.
Keywords:
_no_deeper: Whether this call of the function can call for something that can retrieve
elements too. Recursion protection.

Returns: A WebElement object

Raises:NoSuchElementException – When element is not found on page
cfme.fixtures.pytest_selenium.elements[source]

Convert object o to list of matching WebElements. Can be extended by registering the type of o to this function.

Parameters:o – An object to be converted to a matching web element, eg str, WebElement, tuple.

Returns: A list of WebElement objects

cfme.fixtures.pytest_selenium.execute_script(script, *args, **kwargs)[source]

Wrapper for execute_script() to not have to pull browser() from somewhere.

It also provides our library which is stored in data/lib.js file.

cfme.fixtures.pytest_selenium.get(url)[source]

Changes page to the specified URL

Parameters:url – URL to navigate to.
cfme.fixtures.pytest_selenium.get_alert()[source]
cfme.fixtures.pytest_selenium.get_attribute(loc, attr)[source]

Returns the value of the HTML attribute of the given locator.

Parameters:
  • loc – A locator, expects eithera string, WebElement, tuple.
  • attr – An attribute name.

Returns: Text describing the attribute of the element.

cfme.fixtures.pytest_selenium.get_rails_error()[source]

Get displayed rails error. If not present, return None

cfme.fixtures.pytest_selenium.handle_alert(cancel=False, wait=30.0, squash=False, prompt=None, check_present=False)[source]

Handles an alert popup.

Parameters:
  • cancel – Whether or not to cancel the alert. Accepts the Alert (False) by default.
  • wait – Time to wait for an alert to appear. Default 30 seconds, can be set to 0 to disable waiting.
  • squash – Whether or not to squash errors during alert handling. Default False
  • prompt – If the alert is a prompt, specify the keys to type in here
  • check_present – Does not squash selenium.common.exceptions.NoAlertPresentException
Returns:

True if the alert was handled, False if exceptions were squashed, None if there was no alert.

No exceptions will be raised if squash is True and check_present is False.

Raises:
cfme.fixtures.pytest_selenium.in_flight(script)[source]

Check remaining (running) ajax requests

The element visibility check is complex because lightbox_div invokes visibility of spinner_div although it is not visible.

Parameters:script – Script (string) to execute
Returns:Dictionary of js-related keys and booleans as its values, depending on status. The keys are: jquery, prototype, miq, spinner and document. The values are: True if running, False otherwise.
cfme.fixtures.pytest_selenium.is_alert_present()[source]
cfme.fixtures.pytest_selenium.is_displayed(loc, _deep=0, **kwargs)[source]

Checks if a particular locator is displayed

Parameters:loc – A locator, expects either a string, WebElement, tuple.
Keywords:
move_to: Uses move_to_element() instead of element()

Returns: True if element is displayed, False if not

Raises:
  • NoSuchElementException – If element is not found on page
  • CFMEExceptionOccured – When there is a CFME rails exception on the page.
cfme.fixtures.pytest_selenium.is_displayed_text(text)[source]

Checks if a particular text is displayed

Parameters:text – A string.

Returns: A string containing the text

cfme.fixtures.pytest_selenium.move_to_element(loc, **kwargs)[source]

Moves to an element.

Parameters:loc – A locator, expects either a string, WebElement, tuple.

Returns: Returns the element it was moved to to enable chaining.

cfme.fixtures.pytest_selenium.raw_click(loc, wait_ajax=True)[source]

Does raw selenium’s .click() call on element. Circumvents mouse move.

Parameters:
  • loc – Locator to click on.
  • wait_ajax – Whether to wait for ajax.
cfme.fixtures.pytest_selenium.refresh()[source]

Refreshes the current browser window.

cfme.fixtures.pytest_selenium.select_by_text(select_element, txt)[source]

Works on a select element and selects an option by the visible text.

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • text – The select element option’s visible text.

Returns: previously selected text

cfme.fixtures.pytest_selenium.select_by_value(select_element, val)[source]

Works on a select element and selects an option by the value attribute.

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • value – The select element’s option value.
cfme.fixtures.pytest_selenium.send_keys(loc, text)[source]

Sends the supplied keys to an element. Handles the file upload fields on background.

If it detects the element is and input of type file, it uses the LocalFileDetector so the file gets transferred properly. Otherwise it takes care of having UselessFileDetector.

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • text – The text to inject into the element.
cfme.fixtures.pytest_selenium.set_angularjs_value(loc, value)[source]

Sets value of an element managed by angularjs

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • value – Value to set.
cfme.fixtures.pytest_selenium.set_attribute(loc, attr, value)[source]

Sets the attribute of an element.

This is usually not done, that’s why it is not implemented in selenium. But sometimes ...

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • attr – Attribute name.
  • value – Value to set.
cfme.fixtures.pytest_selenium.set_text(loc, text)[source]

Clears the element and then sends the supplied keys.

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • text – The text to inject into the element.
Returns:

Any text that might have been in the textbox element already
cfme.fixtures.pytest_selenium.tag(loc)[source]

Returns the tag name of an element

Parameters:loc – A locator, expects either a string, WebElement, tuple.

Returns: A string containing the tag element’s name.

cfme.fixtures.pytest_selenium.take_screenshot()[source]
cfme.fixtures.pytest_selenium.text(loc, **kwargs)[source]

Returns the text of an element. Always.

If the element is not visible and the text cannot be retrieved by usual means, JS is used.

Parameters:loc – A locator, expects eithera string, WebElement, tuple.

Returns: A string containing the text of the element.

cfme.fixtures.pytest_selenium.text_content(loc, **kwargs)[source]

Retrieves the text content of the element using JavaScript.

Use if the element is not visible

Parameters:loc – A locator, expects either a string, WebElement or tuple

Returns: A string containing the text of the element.

cfme.fixtures.pytest_selenium.text_sane(loc, **kwargs)[source]

Returns text decoded from UTF-8 and stripped

Parameters:loc – A locator, expects eithera string, WebElement, tuple.

Returns: A string containing the text of the element, decoded and stripped.

cfme.fixtures.pytest_selenium.title()[source]
cfme.fixtures.pytest_selenium.uncheck(loc)[source]

Convenience function to uncheck a checkbox

Parameters:loc – The locator of the element
cfme.fixtures.pytest_selenium.unset_attribute(loc, attr)[source]

Removes an attribute of an element.

This is usually not done, that’s why it is not implemented in selenium. But sometimes ...

Parameters:
  • loc – A locator, expects either a string, WebElement, tuple.
  • attr – Attribute name.
cfme.fixtures.pytest_selenium.value(loc)[source]

Returns the value of an input element.

Parameters:loc – A locator, expects eithera string, WebElement, tuple.

Returns: A string containing the value of the input element.

cfme.fixtures.pytest_selenium.wait_for_ajax()[source]

Waits until all ajax timers are complete, in other words, waits until there are no more pending ajax requests, page load should be finished completely.

Raises:TimedOutError – when ajax did not load in time
cfme.fixtures.pytest_selenium.wait_for_element(*locs, **kwargs)[source]

Wrapper around wait_until, specific to an element.

Parameters:loc – A locator, expects either a string, WebElement, tuple.
Keywords:
all_elements: Whether to wait not for one, but all elements (Default False) timeout: How much time to wait
cfme.fixtures.pytest_selenium.wait_until(f, msg='Webdriver wait timed out', timeout=120.0)[source]

This used to be a wrapper around WebDriverWait from selenium.

Now it is just compatibility layer using utils.wait.wait_for()

cfme.fixtures.rdb module

Rdb: Remote debugger

Given the following configuration in conf/rdb.yaml:

breakpoints:
  - subject: Brief explanation of a problem
    exceptions:
      - cfme.exceptions.ImportableExampleException
      - BuiltinException (e.g. ValueError)
    recipients:
      - user@example.com

Any time an exception listed in a breakpoint’s “exceptions” list is raised in rdb_catch() context in the course of a test run, a remote debugger will be started on a random port, and the users listed in “recipients” will be emailed instructions to access the remote debugger via telnet.

The exceptions will be imported, so their fully-qualified importable path is required. Exceptions without a module path are assumed to be builtins.

An Rdb instance can be used just like a Pdb instance.

Additionally, a signal handler has been set up to allow for triggering Rdb during a test run. To invoke it, kill -USR1 a test-running process and Rdb will start up. No emails are sent when operating in this mode, so check the py.test console for the endpoint address.

By default, Rdb assumes that there is a working MTA available on localhost, but this can be configured in conf['env']['smtp']['server'].

Note

This is very insecure, and should be used as a last resort for debugging elusive failures.

class cfme.fixtures.rdb.Rdb(prompt_msg='')[source]

Bases: pdb.Pdb

Remote Debugger

When set_trace is called, it will open a socket on a random unprivileged port connected to a Pdb debugging session. This session can be accessed via telnet, and will end when “continue” is called in the Pdb session.

do_c(arg)
do_cont(arg)
do_continue(arg)[source]
interaction(*args, **kwargs)[source]
set_trace(*args, **kwargs)[source]

Start a pdb debugger available via telnet, and optionally email people the endpoint

The endpoint will always be seen in the py.test runner output.

Keyword Arguments:
 
  • recipients – A list where, if set, an email will be sent to email addresses in this list.
  • subject – If set, an optional custom email subject
cfme.fixtures.rdb.pytest_internalerror(excrepr, excinfo)[source]
cfme.fixtures.rdb.rdb_catch(*args, **kwds)[source]

Context Manager used to wrap mysterious failures for remote debugging.

cfme.fixtures.rdb.rdb_handle_signal(signal, frame)[source]
cfme.fixtures.rdb.send_breakpoint_email(exctype, msg='')[source]
cfme.fixtures.service_fixtures module
cfme.fixtures.service_fixtures.catalog()[source]
cfme.fixtures.service_fixtures.catalog_item(provider, provisioning, vm_name, dialog, catalog)[source]
cfme.fixtures.service_fixtures.dialog(appliance)[source]
cfme.fixtures.smtp module

This module provides a fixture useful for checking the e-mails arrived.

Main use is of fixture smtp_test(), which is function scoped. There is also a smtp_test_module() fixture for which the smtp_test is just a function-scoped wrapper to speed things up. The base of all this is the session-scoped _smtp_test_session that keeps care about the collector.

cfme.fixtures.smtp.pytest_runtest_call(item)[source]
cfme.fixtures.smtp.smtp_test(request)[source]

Fixture, which prepares the appliance for e-mail capturing tests

Returns: util.smtp_collector_client.SMTPCollectorClient instance.

cfme.fixtures.tag module
cfme.fixtures.tag.category()[source]

Returns random created category object Object can be used in all test run session

cfme.fixtures.tag.check_item_visibility(tag, user_restricted)[source]
cfme.fixtures.tag.group_with_tag(role, category, tag)[source]

Returns group object with set up tag filter used in test module

cfme.fixtures.tag.new_credential()[source]

Returns credentials object used for new user in test module

cfme.fixtures.tag.role()[source]

Returns role object used in test module

cfme.fixtures.tag.tag(category)[source]

Returns random created tag object Object can be used in all test run session

cfme.fixtures.tag.user_restricted(group_with_tag, new_credential)[source]

Returns restricted user object assigned to group with tag filter used in test module

cfme.fixtures.tag.widgetastic_check_tag_visibility(tag, user_restricted)[source]
cfme.fixtures.vm_name module
cfme.fixtures.vm_name.vm_name(provider)[source]
cfme.fixtures.vporizer module
cfme.fixtures.vporizer.gen_vpor_values()[source]
cfme.fixtures.vporizer.random() → x in the interval [0, 1).
class cfme.fixtures.vporizer.vpor_data_instance(resource_type, resource_id, resource_name, cpu_usagemhz_rate_average, derived_memory_used, max_cpu_usage_rate_average, max_mem_usage_absolute_average)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

cpu_usagemhz_rate_average

Alias for field number 3

derived_memory_used

Alias for field number 4

max_cpu_usage_rate_average

Alias for field number 5

max_mem_usage_absolute_average

Alias for field number 6

resource_id

Alias for field number 1

resource_name

Alias for field number 2

resource_type

Alias for field number 0

cfme.fixtures.vporizer.vporizer(appliance)[source]

Grabbing vim_performance_operating_ranges table data for nodes and projects. In case that no such data exists, inserting fake rows

Module contents

A variety of modules intended to make life easier for QE developers.

  • cfme.fixtures.login - A module providing a login generator
  • cfme.fixtures.pytest_selenium - A module offering a large number of CFME optimized selenium wrappers and other auxilliary functions.
cfme.infrastructure package
Subpackages
cfme.infrastructure.provider package
Submodules
cfme.infrastructure.provider.openstack_infra module
class cfme.infrastructure.provider.openstack_infra.OpenStackInfraEndpointForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

default

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

events

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

rsa_keypair

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.provider.openstack_infra.OpenstackInfraProvider(name=None, endpoints=None, key=None, hostname=None, ip_address=None, start_ip=None, end_ip=None, provider_data=None, appliance=None)[source]

Bases: cfme.infrastructure.provider.InfraProvider

STATS_TO_MATCH = ['num_template', 'num_host']
db_types = ['Openstack::InfraManager']
endpoints_form

alias of OpenStackInfraEndpointForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]
has_nodes()[source]
mgmt_class = <Mock name='mock.OpenstackInfraSystem' id='139657638905680'>
node_exist(name='my_node')[source]

” registered imported host exist This function is valid only for RHOS10 and above

Parameters:name – by default name is my_name Input self, name of the new node, looking for the host in Ironic clients, compare the record found with hosts list in CFME DB

Returns: boolean value if host found

register(file_path)[source]

Register new nodes (Openstack) Fill a form for new host with json file format This function is valid only for RHOS10 and above

Parameters:file_path – file path of json file with new node details, navigation MUST be from a specific self
scale_down()[source]

Scales down provider

scale_out(increase_by=1)[source]

Scale out Openstack Infra provider :param increase_by - count of nodes to be added to infra provider:

type_name = 'openstack_infra'
view_value_mapping
class cfme.infrastructure.provider.openstack_infra.ProviderNodes(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProviderNodesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.openstack_infra.ProviderRegisterNodes(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProviderRegisterNodesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.openstack_infra.ProviderRegisterNodesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents Register Nodes view

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

file

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
register

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.provider.openstack_infra.ProviderScaleDown(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProviderScaleDownView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.openstack_infra.ProviderScaleDownView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents Scale down view

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

checkbox

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
scale_down

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.provider.openstack_infra.ProviderScaleOut(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProviderScaleOutView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.openstack_infra.ProviderScaleOutView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents Scale view

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

compute_count

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
scale

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.provider.openstack_infra.RHOSEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

view_value_mapping
cfme.infrastructure.provider.rhevm module
class cfme.infrastructure.provider.rhevm.RHEVMEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

view_value_mapping
class cfme.infrastructure.provider.rhevm.RHEVMEndpointForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

candu

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

default

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.provider.rhevm.RHEVMProvider(name=None, endpoints=None, zone=None, key=None, hostname=None, ip_address=None, start_ip=None, end_ip=None, provider_data=None, appliance=None)[source]

Bases: cfme.infrastructure.provider.InfraProvider

db_types = ['Redhat::InfraManager']
deployment_helper(deploy_args)[source]

Used in utils.virtual_machines

discover_dict = {'rhevm': True}
endpoints_form

alias of RHEVMEndpointForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]
get_console_connection_status()[source]
get_console_ctrl_alt_del_btn()[source]
get_console_fullscreen_btn()[source]
get_remote_console_canvas()[source]
mgmt_class = <Mock name='mock.RHEVMSystem' id='139657643779152'>
type_name = 'rhevm'
view_value_mapping
cfme.infrastructure.provider.scvmm module
class cfme.infrastructure.provider.scvmm.SCVMMEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

view_value_mapping
class cfme.infrastructure.provider.scvmm.SCVMMEndpointForm(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider.DefaultEndpointForm

realm

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

security_protocol

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.provider.scvmm.SCVMMProvider(name=None, endpoints=None, key=None, zone=None, hostname=None, ip_address=None, start_ip=None, end_ip=None, provider_data=None, appliance=None)[source]

Bases: cfme.infrastructure.provider.InfraProvider

STATS_TO_MATCH = ['num_template', 'num_vm']
db_types = ['Microsoft::InfraManager']
deployment_helper(deploy_args)[source]

Used in utils.virtual_machines

discover_dict = {'scvmm': True}
endpoints_form

alias of SCVMMEndpointForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]
mgmt_class = <Mock name='mock.SCVMMSystem' id='139657601429648'>
type_name = 'scvmm'
view_value_mapping
cfme.infrastructure.provider.virtualcenter module
class cfme.infrastructure.provider.virtualcenter.ProviderNodes(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProviderNodesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.virtualcenter.VMwareProvider(name=None, endpoints=None, key=None, zone=None, hostname=None, ip_address=None, start_ip=None, end_ip=None, provider_data=None, appliance=None)[source]

Bases: cfme.infrastructure.provider.InfraProvider

db_types = ['Vmware::InfraManager']
deployment_helper(deploy_args)[source]

Used in utils.virtual_machines

discover_dict = {'vmware': True}
endpoints_form

alias of VirtualCenterEndpointForm

classmethod from_config(prov_config, prov_key, appliance=None)[source]
get_console_connection_status()[source]
get_console_ctrl_alt_del_btn()[source]
get_console_fullscreen_btn()[source]
get_remote_console_canvas()[source]
mgmt_class = <Mock name='mock.VMWareSystem' id='139657554733776'>
type_name = 'virtualcenter'
view_value_mapping
class cfme.infrastructure.provider.virtualcenter.VirtualCenterEndpoint(**kwargs)[source]

Bases: cfme.common.provider.DefaultEndpoint

class cfme.infrastructure.provider.virtualcenter.VirtualCenterEndpointForm(parent, logger=None, **kwargs)[source]

Bases: cfme.common.provider.DefaultEndpointForm

Module contents

A model of an Infrastructure Provider in CFME

class cfme.infrastructure.provider.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraProviderAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraProvidersView

prerequisite

This is a helper descriptor for navigation destinations which are on another class/object.

For instance, imagine you have a different object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToObject as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step on the other object.

resetter()[source]
step()[source]
class cfme.infrastructure.provider.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraProviderDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.infrastructure.provider.Discover(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraProvidersDiscoverView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraProviderEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvidersEditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.EditTagsFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvidersEditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.InfraProvider(name=None, endpoints=None, key=None, zone=None, provider_data=None, appliance=None)[source]

Bases: utils.pretty.Pretty, cfme.common.provider.CloudInfraProvider, widgetastic.utils.Fillable

Abstract model of an infrastructure provider in cfme. See VMwareProvider or RHEVMProvider.

Parameters:
  • name – Name of the provider.
  • details – a details record (see VMwareDetails, RHEVMDetails inner class).
  • key – The CFME key of the provider in the yaml.
  • endpoints – one or several provider endpoints like DefaultEndpoint. it should be either dict
  • format dict{endpoint.name, endpoint, endpoint_n.name, endpoint_n}, list of endpoints or (in) –
  • one endpoint (mere) –

Usage:

credentials = Credential(principal='bad', secret='reallybad')
endpoint = DefaultEndpoint(hostname='some_host', api_port=65536, credentials=credentials)
myprov = VMwareProvider(name='foo',
                     region='us-west-1'
                     endpoints=endpoint)
myprov.create()
STATS_TO_MATCH = ['num_template', 'num_vm', 'num_datastore', 'num_host', 'num_cluster']
as_fill_value()[source]
category = 'infra'
db_types = ['InfraManager']
discover()[source]

Begins provider discovery from a provider instance

Usage:

discover_from_config(utils.providers.get_crud('rhevm'))
get_clusters()[source]

returns the list of clusters belonging to the provider

hosts

Returns list of cfme.infrastructure.host.Host that should belong to this provider according to the YAML

id

returns current provider id using rest api

num_cluster(*args, **kwargs)
num_cluster_db = None
num_cluster_ui = None
num_datastore(*args, **kwargs)
num_datastore_ui = None
num_host(*args, **kwargs)
num_host_db = None
num_host_ui = None
page_name = 'infrastructure'
pretty_attrs = ['name', 'key', 'zone']
provider_types = {}
string_name = 'Infrastructure'
templates_destination_name = 'Templates'
view_value_mapping
vm_name
class cfme.infrastructure.provider.Instances(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.infrastructure.provider.ManagePolicies(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvidersManagePoliciesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.ManagePoliciesFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvidersManagePoliciesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.provider.Templates(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.infrastructure.provider.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProviderTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.infrastructure.provider.discover(discover_cls, cancel=False, start_ip=None, end_ip=None)[source]

Discover infrastructure providers. Note: only starts discovery, doesn’t wait for it to finish.

Parameters:
  • discover_cls – Instance of provider class
  • cancel – Whether to cancel out of the discover UI.
  • start_ip – String start of the IP range for discovery
  • end_ip – String end of the IP range for discovery
cfme.infrastructure.provider.get_all_providers()[source]

Returns list of all providers

cfme.infrastructure.provider.wait_for_a_provider()[source]
Submodules
cfme.infrastructure.cluster module

A model of an Infrastructure Cluster in CFME

var page:A cfme.web_ui.Region object describing common elements on the Cluster pages.
class cfme.infrastructure.cluster.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ClusterAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]

Reset the view

step(*args, **kwargs)[source]

Navigate to the correct view

class cfme.infrastructure.cluster.Cluster(name, provider, collection=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

Model of an infrastructure cluster in cfme

Parameters:
  • name – Name of the cluster.
  • provider – provider this cluster is attached to.

Note

If given a provider_key, it will navigate through Infrastructure/Providers instead of the direct path through Infrastructure/Clusters.

delete(cancel=True, wait=False)[source]

Deletes a cluster from CFME

Parameters:
  • cancel – Whether to cancel the deletion, defaults to True
  • wait – Whether or not to wait for the delete to complete, defaults to False
exists
get_detail(*ident)[source]

Gets details from the details infoblock

The function first ensures that we are on the detail page for the specific cluster.

Parameters:
  • *ident – An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”
  • string representing the contents of the InfoBlock's value. (A) –
id

extracts cluster id for this cluster

pretty_attrs = ['name', 'provider']
run_smartstate_analysis()[source]

Run SmartState analysis

short_name

returns only cluster’s name exactly how it is stored in DB (without datacenter part)

wait_for_disappear(timeout=300)[source]
wait_for_exists()[source]

Wait for the cluster to be refreshed

class cfme.infrastructure.cluster.ClusterAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.cluster.ClusterView

The all view page for clusters

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Determine if this page is currently being displayed

paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.cluster.ClusterCollection(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

Collection object for the cfme.infrastructure.cluster.Cluster.

delete(*clusters)[source]

Delete one or more Clusters from the list of the Clusters

Parameters:of the cfme.infrastructure.cluster.Cluster objects (list) –
instantiate(name, provider)[source]
class cfme.infrastructure.cluster.ClusterDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The accordion on the details page

cluster

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.cluster.ClusterDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

A cluster properties on the details page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

totals_for_hosts

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

totals_for_vms

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.cluster.ClusterDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the detail page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.cluster.ClusterDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.cluster.ClusterView

The details page of a cluster

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Determine if this page is currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.cluster.ClusterEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

A list of clusters

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

search

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.cluster.ClusterTimelinesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.TimelinesView, cfme.infrastructure.cluster.ClusterView

The timelines page of a cluster

is_displayed

Determine if this page is currently being displayed

class cfme.infrastructure.cluster.ClusterToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.cluster.ClusterView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Base view for all the cluster views

in_cluster

Determine if the browser has navigated to the Cluster page

class cfme.infrastructure.cluster.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ClusterDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Navigate to the correct view

class cfme.infrastructure.cluster.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ClusterTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Navigate to the correct view

cfme.infrastructure.config_management module
class cfme.infrastructure.config_management.AnsibleTower(name=None, url=None, ssl=None, credentials=None, key=None)[source]

Bases: cfme.infrastructure.config_management.ConfigManager

Configuration manager object (Ansible Tower)

Parameters:
  • name – Name of the Ansible Tower configuration manager
  • url – URL, hostname or IP of the configuration manager
  • ssl – Boolean value; True if SSL certificate validity should be checked, False otherwise
  • credentials – Credentials to access the config. manager
  • key – Key to access the cfme_data yaml data (same as name if not specified)

Usage:

Create provider:
.. code-block:: python

    tower_cfg_mgr = AnsibleTower('my_tower', 'https://my-tower.example.com/api/v1',
                        ssl=False, ConfigManager.Credential(principal='admin',
                        secret='testing'), key='tower_yaml_key')
    tower_cfg_mgr.create()

Update provider:
.. code-block:: python

    with update(tower_cfg_mgr):
        tower_cfg_mgr.name = 'new_tower_name'

Delete provider:
.. code-block:: python

    tower_cfg_mgr.delete()
type = 'Ansible Tower'
class cfme.infrastructure.config_management.ConfigManager(name=None, url=None, ssl=None, credentials=None, key=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

This is base class for Configuration manager objects (Red Hat Satellite, Foreman, Ansible Tower)

Parameters:
  • name – Name of the config. manager
  • url – URL, hostname or IP of the config. manager
  • ssl – Boolean value; True if SSL certificate validity should be checked, False otherwise
  • credentials – Credentials to access the config. manager
  • key – Key to access the cfme_data yaml data (same as name if not specified)

Usage:

Use Satellite or AnsibleTower classes instead.
class Credential(principal, secret, verify_secret=None, domain=None, **ignore)[source]

Bases: cfme.base.credential.Credential, utils.update.Updateable

ConfigManager.config_profiles

Returns ‘ConfigProfile’ configuration profiles (hostgroups) available on this manager

ConfigManager.create(cancel=False, validate_credentials=True, validate=True, force=False)[source]

Creates the manager through UI

Parameters:
  • cancel (bool) – Whether to cancel out of the creation. The cancel is done after all the information present in the manager has been filled in the UI.
  • validate_credentials (bool) – Whether to validate credentials - if True and the credentials are invalid, an error will be raised.
  • validate (bool) – Whether we want to wait for the manager’s data to load and show up in it’s detail page. True will also wait, False will only set it up.
  • force (bool) – Whether to force the creation even if the manager already exists. True will try anyway; False will check for its existence and leave, if present.
ConfigManager.delete(cancel=False, wait_deleted=True, force=False)[source]

Deletes the manager through UI

Parameters:
  • cancel (bool) – Whether to cancel out of the deletion, when the alert pops up.
  • wait_deleted (bool) – Whether we want to wait for the manager to disappear from the UI. True will wait; False will only delete it and move on.
  • force (bool) – Whether to try to delete the manager even though it doesn’t exist. True will try to delete it anyway; False will check for its existence and leave, if not present.
ConfigManager.exists

Returns whether the manager exists in the UI or not

classmethod ConfigManager.load_from_yaml(key)[source]

Returns ‘ConfigManager’ object loaded from yamls, based on its key

ConfigManager.pretty_attr = ['name', 'url']
ConfigManager.quad_name
ConfigManager.refresh_relationships(cancel=False)[source]

Refreshes relationships and power states of this manager

ConfigManager.systems

Returns ‘ConfigSystem’ configured systems (hosts) available on this manager

ConfigManager.type = None
ConfigManager.update(updates, cancel=False, validate_credentials=False)[source]

Updates the manager through UI

Parameters:
  • updates (dict) – Data to change.
  • cancel (bool) – Whether to cancel out of the update. The cancel is done after all the new information has been filled in the UI.
  • validate_credentials (bool) – Whether to validate credentials - if True and the credentials are invalid, an error will be raised.

Note

utils.update use is recommended over use of this method.

ConfigManager.yaml_data

Returns yaml data for this manager

class cfme.infrastructure.config_management.ConfigProfile(name, manager, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

Configuration profile object (foreman-side hostgroup)

Parameters:
  • name – Name of the profile
  • manager – ConfigManager object which this profile is bound to
pretty_attrs = ['name', 'manager']
systems

Returns ‘ConfigSystem’ objects that are active under this profile

class cfme.infrastructure.config_management.ConfigSystem(name, profile, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

pretty_attrs = ['name', 'manager_key']
tag(tag)[source]

Tags the system by given tag

tags

Returns a list of this system’s active tags

untag(tag)[source]

Removes the selected tag off the system

class cfme.infrastructure.config_management.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.config_management.MgrAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.config_management.MgrAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.infrastructure.config_management.MgrDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.config_management.MgrEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.config_management.MgrEditFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.config_management.Satellite(name=None, url=None, ssl=None, credentials=None, key=None)[source]

Bases: cfme.infrastructure.config_management.ConfigManager

Configuration manager object (Red Hat Satellite, Foreman)

Parameters:
  • name – Name of the Satellite/Foreman configuration manager
  • url – URL, hostname or IP of the configuration manager
  • ssl – Boolean value; True if SSL certificate validity should be checked, False otherwise
  • credentials – Credentials to access the config. manager
  • key – Key to access the cfme_data yaml data (same as name if not specified)

Usage:

Create provider:
.. code-block:: python

    satellite_cfg_mgr = Satellite('my_satellite', 'my-satellite.example.com',
                        ssl=False, ConfigManager.Credential(principal='admin',
                        secret='testing'), key='satellite_yaml_key')
    satellite_cfg_mgr.create()

Update provider:
.. code-block:: python

    with update(satellite_cfg_mgr):
        satellite_cfg_mgr.name = 'new_satellite_name'

Delete provider:
.. code-block:: python

    satellite_cfg_mgr.delete()
type

Returns presumed type of the manager based on CFME version

Note

We cannot actually know the type of the provider from the UI. This represents the supported type by CFME version and is to be used in navigation.

class cfme.infrastructure.config_management.SysAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.infrastructure.config_management.SysEditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.config_management.SysProvision(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.infrastructure.config_management.cfm_mgr_table()[source]
cfme.infrastructure.config_management.get_config_manager_from_config(cfg_mgr_key)[source]
cfme.infrastructure.datastore module

A model of an Infrastructure Datastore in CFME

class cfme.infrastructure.datastore.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DatastoresView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]

resets page to default state when user navigates to All Datastores destination

step()[source]
class cfme.infrastructure.datastore.Datastore(name, provider, type=None, collection=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

Model of an infrastructure datastore in cfme

Parameters:
  • name – Name of the datastore.
  • provider – provider this datastore is attached to.
delete(cancel=True)[source]

Deletes a datastore from CFME

Parameters:cancel – Whether to cancel the deletion, defaults to True

Note

Datastore must have 0 hosts and 0 VMs for this to work.

delete_all_attached_hosts()[source]
delete_all_attached_vms()[source]
exists
get_hosts()[source]

Returns names of hosts (from quadicons) that use this datastore

Returns: List of strings with names or [] if no hosts found.

get_vms()[source]

Returns names of VMs (from quadicons) that use this datastore

Returns: List of strings with names or [] if no vms found.

pretty_attrs = ['name', 'provider_key']
run_smartstate_analysis()[source]

Runs smartstate analysis on this host

Note

The host must have valid credentials already set up for this to work.

class cfme.infrastructure.datastore.DatastoreCollection(appliance=None)[source]

Bases: utils.appliance.Navigatable

Collection class for cfme.infrastructure.datastore.Datastore

delete(*datastores)[source]

Note

Datastores must have 0 hosts and 0 VMs for this to work.

instantiate(name, provider, type=None)[source]
run_smartstate_analysis(*datastores)[source]
class cfme.infrastructure.datastore.DatastoreDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

represents Datastore Details page

contents

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.datastore.DatastoreEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

represents central view where all QuadIcons, etc are displayed

class cfme.infrastructure.datastore.DatastoreSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents left side bar. it usually contains navigation, filters, etc

clusters

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

datastores

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.datastore.DatastoreToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents datastore toolbar and its controls

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.datastore.DatastoresView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

represents whole All Datastores page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.datastore.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DatastoreDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.datastore.DetailsFromProvider(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DatastoreDetailsView

step()[source]
class cfme.infrastructure.datastore.HostAllDatastoresView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.datastore.DatastoresView

entities
is_displayed
class cfme.infrastructure.datastore.RegisteredHostsView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.host_views.HostsView

represents Hosts related to some datastore

entities
is_displayed
cfme.infrastructure.datastore.get_all_datastores()[source]

Returns names (from quadicons) of all datastores

cfme.infrastructure.deployment_roles module

A model of an Infrastructure Deployment roles in CFME

class cfme.infrastructure.deployment_roles.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DeploymentRoleAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.deployment_roles.AllForProvider(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DeploymentRoleAllForProviderView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.deployment_roles.DepRoleListEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseListEntity

class cfme.infrastructure.deployment_roles.DepRoleQuadIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseQuadIconEntity

data
class cfme.infrastructure.deployment_roles.DepRoleTileIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseTileIconEntity

quad_icon

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleAllForProviderView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.deployment_roles.DeploymentRoleView

The Deployment Role for Provider page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

entities
is_displayed

Is this page currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.deployment_roles.DeploymentRoleView

The all Deployment Role page

entities
is_displayed

This is page currently being displayed

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleCollection(appliance)[source]

Bases: utils.appliance.NavigatableMixin

Collection object for the :py:class:’cfme.infrastructure.deployment_role.DeploymentRoles’

all(provider)[source]
delete(*roles)[source]

Delete one or more Deployment Role from list of Deployment Roles

Parameters:or Multiple 'cfme.infrastructure.deployment_role.DeploymentRoles' objects (One) –
instantiate(name, provider)[source]
class cfme.infrastructure.deployment_roles.DeploymentRoleComparisonEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities on compare Deployment role page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleComparisonToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on Comparison Page of roles

all_attributes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

details_mode

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

different_values_attributes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

exists_mode

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

same_values_attributes

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleComparisonView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.deployment_roles.DeploymentRoleView

The page for comparison of Deployment Role

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The accordion on the Deployment Role details page

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The entities on the Deployment Role details page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

total_for_node

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

total_for_vm

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the Deployment Role details page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.deployment_roles.DeploymentRoleView

The details page for a Deployment Roles

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleEditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.deployment_roles.DeploymentRoleView

The edit tags of Deployment Role

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently being displayed

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleEntitiesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

The entities on the main list Deployment Role page

entity_class
cfme.infrastructure.deployment_roles.DeploymentRoleEntity()[source]

Temporary wrapper for Deployment Role Entity during transition to JS based Entity

class cfme.infrastructure.deployment_roles.DeploymentRoleManagePoliciesView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.deployment_roles.DeploymentRoleView

Deployment role Manage Policies view.

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page currently displayed

policies

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the Deployment Role page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoleView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

A base view for all the Deployment Role pages

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_dep_role

Determine if the Deployment page is currently open

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.deployment_roles.DeploymentRoles(name, provider, collection)[source]

Bases: utils.appliance.NavigatableMixin

Model of an infrastructure deployment roles in cfme

Parameters:
  • name – Name of the role.
  • provider – provider this role is attached to (deployment roles available only for Openstack!).
delete(cancel=False)[source]
class cfme.infrastructure.deployment_roles.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DeploymentRoleDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Navigate to the details page of Role

class cfme.infrastructure.deployment_roles.DetailsFromProvider(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DeploymentRoleDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.deployment_roles.NonJSDepRoleEntity(parent, name, logger=None)[source]

Bases: widgetastic_manageiq.NonJSBaseEntity

list_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

quad_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tile_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.infrastructure.host module

A model of an Infrastructure Host in CFME.

class cfme.infrastructure.host.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of HostAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.host.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of HostsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.host.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of HostDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.host.Discover(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of HostDiscoverView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.host.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of HostEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.host.Host(name=None, hostname=None, ip_address=None, custom_ident=None, host_platform=None, ipmi_address=None, mac_address=None, credentials=None, ipmi_credentials=None, interface_type='lan', provider=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable, cfme.common.PolicyProfileAssignable

Model of an infrastructure host in cfme.

Parameters:
  • name – Name of the host.
  • hostname – Hostname of the host.
  • ip_address – The IP address as a string.
  • custom_ident – The custom identifiter.
  • host_platform – Included but appears unused in CFME at the moment.
  • ipmi_address – The IPMI address.
  • mac_address – The mac address of the system.
  • credentials (Credential) – see Credential inner class.
  • ipmi_credentials (Credential) – see Credential inner class.

Usage:

myhost = Host(name='vmware',
              credentials=Provider.Credential(principal='admin', secret='foobar'))
myhost.create()
class Credential(**kwargs)[source]

Bases: cfme.base.credential.Credential, utils.update.Updateable

Provider credentials

Parameters:**kwargs – If using IPMI type credential, ipmi = True
Host.check_compliance(timeout=240)[source]

Initiates compliance check and waits for it to finish.

Host.compliance_status

Returns the title of the compliance SummaryTable. The title contains datetime so it can be compared.

Returns:NoneType if no title is present (no compliance checks before), otherwise str
Host.create(cancel=False, validate_credentials=False)[source]

Creates a host in the UI.

Parameters:
  • cancel (bool) – Whether to cancel out of the creation. The cancel is done after all the information present in the Host has been filled in the UI.
  • validate_credentials (bool) – Whether to validate credentials - if True and the credentials are invalid, an error will be raised.
Host.delete(cancel=True)[source]

Deletes this host from CFME.

Parameters:cancel (bool) – Whether to cancel the deletion, defaults to True
Host.equal_drift_results(drift_section, section, *indexes)[source]

Compares drift analysis results of a row specified by it’s title text.

Parameters:
  • drift_section (str) – Title text of the row to compare
  • section (str) – Accordion section where the change happened
  • indexes – Indexes of results to compare starting with 0 for first row (latest result). Compares all available drifts, if left empty (default)

Note

There have to be at least 2 drift results available for this to work.

Returns:bool
Host.execute_button(button_group, button, handle_alert=False)[source]
Host.exists

Checks if the host exists in the UI.

Returns: bool

Host.get_datastores()[source]

Gets list of all datastores used by this host.

Returns: list of datastores names

Host.get_db_id
Host.get_detail(title, field)[source]

Gets details from the details summary tables.

Parameters:
  • title (str) – Summary Table title
  • field (str) – Summary table field name

Returns: A string representing the entities of the SummaryTable’s value.

Host.get_ipmi()[source]
Host.get_power_state()[source]
Host.has_valid_credentials

Checks if host has valid credentials save.

Returns: bool

Host.is_compliant

Check if the Host is compliant.

Returns:bool
Host.load_details(refresh=False)[source]

To be compatible with the Taggable and PolicyProfileAssignable mixins.

Parameters:refresh (bool) – Whether to perform the page refresh, defaults to False
Host.power_off()[source]
Host.power_on()[source]
Host.pretty_attrs = ['name', 'hostname', 'ip_address', 'custom_ident']
Host.refresh(cancel=False)[source]

Perform ‘Refresh Relationships and Power States’ for the host.

Parameters:cancel (bool) – Whether the action should be cancelled, default to False
Host.run_smartstate_analysis()[source]

Runs smartstate analysis on this host.

Note

The host must have valid credentials already set up for this to work.

Host.tag(tag, **kwargs)[source]

Tags the system by given tag

Host.untag(tag)[source]

Removes the selected tag off the system

Host.update(updates, validate_credentials=False)[source]

Updates a host in the UI. Better to use utils.update.update context manager than call this directly.

Parameters:updates (dict) – fields that are changing.
Host.update_credentials_rest(credentials)[source]

Updates host’s credentials via rest api

Parameters:credentials (dict) – credentials from yaml file

Returns: True if credentials are saved and valid; False otherwise

Host.wait_for_host_state_change(desired_state, timeout=300)[source]

Wait for Host to come to desired state. This function waits just the needed amount of time thanks to wait_for.

Parameters:
  • desired_state (str) – ‘on’ or ‘off’
  • timeout (int) – Specify amount of time (in seconds) to wait until TimedOutError is raised
class cfme.infrastructure.host.PolicyAssignment(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of HostManagePoliciesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.host.Provision(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.host.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of HostTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.infrastructure.host.get_all_hosts()[source]

Returns names list of all hosts.

Returns:names list of all hosts
Return type:list
cfme.infrastructure.host.get_credentials_from_config(credential_config_name)[source]
cfme.infrastructure.host.get_from_config(provider_config_name)[source]

Creates a Host object given a yaml entry in cfme_data.

Usage:

get_from_config('esx')

Returns: A Host object that has methods that operate on CFME

cfme.infrastructure.host.wait_for_a_host()[source]

Waits for any host to appear in the UI.

cfme.infrastructure.host.wait_for_host_delete(host)[source]

Waits for the host to remove from the UI.

Parameters:host (Host) – host object
cfme.infrastructure.host.wait_for_host_to_appear(host)[source]

Waits for the host to appear in the UI.

Parameters:host (Host) – host object
cfme.infrastructure.networking module
class cfme.infrastructure.networking.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.infrastructure.networking.InfraNetworking(appliance=None)[source]

Bases: utils.appliance.Navigatable

cfme.infrastructure.openstack_node module

A model of an Openstack Infrastructure Node in CFME.

class cfme.infrastructure.openstack_node.OpenstackNode(name=None, hostname=None, ip_address=None, custom_ident=None, host_platform=None, ipmi_address=None, mac_address=None, credentials=None, ipmi_credentials=None, interface_type='lan', provider=None, appliance=None)[source]

Bases: cfme.infrastructure.host.Host

Model of Openstack Infrastructure node. Extends the behavior of Infrastructure Host with Openstack-only functions. For usage and __init__ args check the doc to Host class

provide_node()[source]

Provide node - make it available

run_introspection()[source]

Run introspection

toggle_maintenance_mode()[source]

Initiate maintenance mode

cfme.infrastructure.pxe module

A model of a PXE Server in CFME

class cfme.infrastructure.pxe.CustomizationTemplate(name=None, description=None, image_type=None, script_type=None, script_data=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Model of a Customization Template in CFME

Parameters:
  • name – The name of the template.
  • description – Template description.
  • image_type – Image type name, must be one of an existing System Image Type.
  • script_type – Script type, either Kickstart, Cloudinit or Sysprep.
  • script_data – The scripts data.
create(cancel=False)[source]

Creates a Customization Template object

Parameters:cancel (boolean) – Whether to cancel out of the creation. The cancel is done after all the information present in the CT has been filled in the UI.
delete(cancel=True)[source]

Deletes a Customization Template server from CFME

Parameters:cancel – Whether to cancel the deletion, defaults to True
exists(*args, **kwargs)
exists_ui = None
pretty_attrs = ['name', 'image_type']
update(updates, cancel=False)[source]

Updates a Customization Template server in the UI. Better to use utils.update.update context manager than call this directly.

Parameters:
  • updates (dict) – fields that are changing.
  • cancel (boolean) – whether to cancel out of the update.
class cfme.infrastructure.pxe.CustomizationTemplateAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXECustomizationTemplateAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.CustomizationTemplateAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXECustomizationTemplatesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.CustomizationTemplateDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXECustomizationTemplateDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.CustomizationTemplateEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXECustomizationTemplateEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.ISODatastore(provider=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Model of a PXE Server object in CFME

Parameters:provider – Provider name.
create(cancel=False, refresh=True, refresh_timeout=120)[source]

Creates an ISO datastore object

Parameters:
  • cancel (boolean) – Whether to cancel out of the creation. The cancel is done after all the information present in the ISO datastore has been filled in the UI.
  • refresh (boolean) – Whether to run the refresh operation on the ISO datastore after the add has been completed.
delete(cancel=True)[source]

Deletes an ISO Datastore from CFME

Parameters:cancel – Whether to cancel the deletion, defaults to True
exists(*args, **kwargs)
exists_ui = None
pretty_attrs = ['provider']
refresh(wait=True, timeout=120)[source]

Refreshes the PXE relationships and waits for it to be updated

set_iso_image_type(image_name, image_type)[source]

Function to set the image type of a PXE image

class cfme.infrastructure.pxe.ISODatastoreAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXEDatastoreAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.ISODatastoreAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXEDatastoresView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.ISODatastoreDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXEDatastoreDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.PXECustomizationTemplateAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXECustomizationTemplateForm

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXECustomizationTemplateDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEMainView

represents some certain Customization Template Details page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXECustomizationTemplateEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXECustomizationTemplateForm

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXECustomizationTemplateForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

image_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

script

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXECustomizationTemplatesView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEMainView

represents Customization Template Groups page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.infrastructure.pxe.PXEDatastoreAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEDatastoreForm

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEDatastoreDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEMainView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEDatastoreEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEDatastoreForm

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEDatastoreForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEDatastoresView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEMainView

represents whole All ISO Datastores page

is_displayed
class cfme.infrastructure.pxe.PXEDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEToolBar

represents the toolbar which appears when any pxe entity is clicked

reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEImageEditView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

it can be found when some image is clicked in PXE Server Tree

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

default_for_windows

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEMainPage(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.PXEMainView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

represents whole All PXE Servers page

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEServer(name=None, depot_type=None, uri=None, userid=None, password=None, access_url=None, pxe_dir=None, windows_dir=None, customize_dir=None, menu_filename=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Model of a PXE Server object in CFME

Parameters:
  • name – Name of PXE server.
  • depot_type – Depot type, either Samba or Network File System.
  • uri – The Depot URI.
  • userid – The Samba username.
  • password – The Samba password.
  • access_url – HTTP access path for PXE server.
  • pxe_dir – The PXE dir for accessing configuration.
  • windows_dir – Windows source directory.
  • customize_dir – Customization directory for templates.
  • menu_filename – Menu filename for iPXE/syslinux menu.
create(cancel=False, refresh=True, refresh_timeout=120)[source]

Creates a PXE server object

Parameters:
  • cancel (boolean) – Whether to cancel out of the creation. The cancel is done after all the information present in the PXE Server has been filled in the UI.
  • refresh (boolean) – Whether to run the refresh operation on the PXE server after the add has been completed.
delete(cancel=True)[source]

Deletes a PXE server from CFME

Parameters:cancel – Whether to cancel the deletion, defaults to True
exists(*args, **kwargs)
exists_ui = None
get_pxe_image_type(*args, **kwargs)
get_pxe_image_type_ui = None
pretty_attrs = ['name', 'uri', 'access_url']
refresh(wait=True, timeout=120)[source]

Refreshes the PXE relationships and waits for it to be updated

set_pxe_image_type(image_name, image_type)[source]

Function to set the image type of a PXE image

update(updates, cancel=False)[source]

Updates a PXE server in the UI. Better to use utils.update.update context manager than call this directly.

Parameters:
  • updates (dict) – fields that are changing.
  • cancel (boolean) – whether to cancel out of the update.
class cfme.infrastructure.pxe.PXEServerAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXEServerAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.PXEServerAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEServerForm

represents Add New PXE Server view

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEServerAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXEServersView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.PXEServerDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXEServerDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.PXEServerDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEMainView

represents Server Details view

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEServerEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXEServerEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.PXEServerEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEServerForm

represents PXE Server Edit view

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEServerForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

access_url

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

confirm_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

customization_dir

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

depot_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

filename

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

pxe_dir

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

uri

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

username

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

validate

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

windows_images_dir

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXEServersView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEMainView

represents whole All PXE Servers page

is_displayed
class cfme.infrastructure.pxe.PXESideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents left side bar. it usually contains navigation, filters, etc

datastores

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

image_types

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

servers

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

templates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXESystemImageTypeAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXESystemImageTypeForm

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXESystemImageTypeDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEMainView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXESystemImageTypeEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXESystemImageTypeForm

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXESystemImageTypeForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.PXESystemImageTypesView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.pxe.PXEMainView

represents whole All System Image Types page

is_displayed
class cfme.infrastructure.pxe.PXEToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

represents PXE toolbar and its controls

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.pxe.SystemImageType(name=None, provision_type=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Model of a System Image Type in CFME.

Parameters:
  • name – The name of the System Image Type.
  • provision_type – The provision type, either Vm or Host.
HOST_OR_NODE = 'Host / Node'
VM_OR_INSTANCE = 'VM and Instance'
create(cancel=False)[source]

Creates a System Image Type object

Parameters:cancel (boolean) – Whether to cancel out of the creation. The cancel is done after all the information present in the SIT has been filled in the UI.
delete(cancel=True)[source]

Deletes a System Image Type from CFME

Parameters:cancel – Whether to cancel the deletion, defaults to True
pretty_attrs = ['name', 'provision_type']
update(updates, cancel=False)[source]

Updates a System Image Type in the UI. Better to use utils.update.update context manager than call this directly.

Parameters:
  • updates (dict) – fields that are changing.
  • cancel (boolean) – whether to cancel out of the update.
class cfme.infrastructure.pxe.SystemImageTypeAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXESystemImageTypeAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.SystemImageTypeAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXESystemImageTypesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.SystemImageTypeDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXESystemImageTypeDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.pxe.SystemImageTypeEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PXESystemImageTypeEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.infrastructure.pxe.get_pxe_server_from_config(pxe_config_name)[source]

Convenience function to grab the details for a pxe server fomr the yamls.

cfme.infrastructure.pxe.get_template_from_config(template_config_name)[source]

Convenience function to grab the details for a template from the yamls.

cfme.infrastructure.pxe.remove_all_pxe_servers()[source]

Convenience function to remove all PXE servers

cfme.infrastructure.resource_pool module

A model of an Infrastructure Resource pool in CFME

var page:A cfme.web_ui.Region object describing common elements on the Resource pool pages.
class cfme.infrastructure.resource_pool.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

A navigation step for the All page

VIEW

alias of ResourcePoolAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]

Reset view and selection

step(*args, **kwargs)[source]
class cfme.infrastructure.resource_pool.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

A navigation step for the Details page

VIEW

alias of ResourcePoolDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]

Navigate to the item

class cfme.infrastructure.resource_pool.ResourcePool(name=None, provider_key=None, appliance=None)[source]

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

Model of an infrastructure Resource pool in cfme

Parameters:
  • name – Name of the Resource pool.
  • provider_key – Name of the provider this resource pool is attached to.

Note

If given a provider_key, it will navigate through Infrastructure/Providers instead of the direct path through Infrastructure/Resourcepool.

delete(cancel=True, wait=False)[source]

Deletes a resource pool from CFME

Parameters:
  • cancel – Whether or not to cancel the deletion, defaults to True
  • wait – Whether or not to wait for the delete, defaults to False
exists
get_detail(*ident)[source]

Gets details from the details infoblock

The function first ensures that we are on the detail page for the specific resource pool.

Parameters:ident – An InfoBlock title, followed by the Key name, e.g. “Properties”
Returns:A string representing the contents of the InfoBlock’s value.
Return type:returns
pretty_attrs = ['name', 'provider_key']
wait_for_exists()[source]

Wait for the resource pool to be created

class cfme.infrastructure.resource_pool.ResourcePoolAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.resource_pool.ResourcePoolView

The “all” view – a list of app the resource pools

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.resource_pool.ResourcePoolDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The accordian on the details page

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.resource_pool.ResourcePoolDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Entities on the details page

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.resource_pool.ResourcePoolDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the details page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.resource_pool.ResourcePoolDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.resource_pool.ResourcePoolView

The details page of a resource pool

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

Is this page being displayed?

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.resource_pool.ResourcePoolEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Entities on the main list page

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

search

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.resource_pool.ResourcePoolToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The toolbar on the main page

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.resource_pool.ResourcePoolView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Base view for header and nav checking, navigatable views should inherit this

in_resource_pool
cfme.infrastructure.virtual_machines module

A model of Infrastructure Virtual Machines area of CFME. This includes the VMs explorer tree, quadicon lists, and VM details page.

class cfme.infrastructure.virtual_machines.Genealogy(o)[source]

Bases: object

Class, representing genealogy of an infra object with possibility of data retrieval and comparison.

Parameters:o – The Vm or Template object.
ancestors

Returns list of ancestors of the represented object.

apply_button = FormButton('Apply sections')
attr_mapping = {'all': 'All Attributes', 'different': 'Attributes with different values', 'same': 'Attributes with same values'}
compare(*objects, **kwargs)[source]

Compares two or more objects in the genealogy.

Parameters:*objects – Vm or Template or str with name.
Keywords:
sections: Which sections to compare. attributes: all, different or same. Default: all. mode: exists or details. Default: exists.
genealogy_tree = <cfme.web_ui.BootstrapTreeview object>
mode_mapping = {'details': 'Details Mode', 'exists': 'Exists Mode'}
navigate()[source]
section_comparison_tree = <cfme.web_ui.CheckboxTree locator="//div[@id='all_sections_treebox']/div/table">
tree

Returns contents of the tree with genealogy

class cfme.infrastructure.virtual_machines.InfraGenericDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.InfraVmDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.virtual_machines.InfraGenericDetailsToolbar

Toolbar for VM details differs from All VMs&TemplatesView

access

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.InfraVmDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.virtual_machines.InfraVmView

TemplatesToolbar = None
VmsToolbar = None
entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

Conditional switchable view implementation.

This widget proxy is useful when you have a form whose parts displayed depend on certain conditions. Eg. when you select certain value from a dropdown, one form is displayed next, when other value is selected, a different form is displayed next. This widget proxy is designed to register those multiple views and then upon accessing decide which view to use based on the registration conditions.

The resulting widget proxy acts similarly like a nested view (if you use view of course).

Example

class SomeForm(View):
    foo = Input('...')
    action_type = Select(name='action_type')

    action_form = ConditionalSwitchableView(reference='action_type')

    # Simple value matching. If Action type 1 is selected in the select, use this view.
    # And if the action_type value does not get matched, use this view as default
    @action_form.register('Action type 1', default=True)
    class ActionType1Form(View):
        widget = Widget()

    # You can use a callable to declare the widget values to compare
    @action_form.register(lambda action_type: action_type == 'Action type 2')
    class ActionType2Form(View):
        widget = Widget()

    # With callable, you can use values from multiple widgets
    @action_form.register(
        lambda action_type, foo: action_type == 'Action type 2' and foo == 2)
    class ActionType2Form(View):
        widget = Widget()

You can see it gives you the flexibility of decision based on the values in the view.

Parameters:
  • reference – For using non-callable conditions, this must be specified. Specifies the name of the widget whose value will be used for comparing non-callable conditions. Supports going across objects using ..
  • ignore_bad_reference – If this is enabled, then when the widget representing the reference is not displayed or otherwise broken, it will then use the default view.
class cfme.infrastructure.virtual_machines.InfraVmReconfigureView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cores_per_socket

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cpu

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cpu_total

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

disks_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed = False
mem_size

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

mem_size_unit

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

memory

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

sockets

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

submit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.InfraVmSummaryView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.vm_views.VMDetailsEntities

datastore_allocation

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

datastore_usage

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

operating_ranges

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.InfraVmTimelinesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.TimelinesView, cfme.base.login.BaseLoggedInPage

is_displayed
class cfme.infrastructure.virtual_machines.InfraVmView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Base view for header/nav check, inherit for navigatable views

in_infra_vms
class cfme.infrastructure.virtual_machines.MigrateView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.ProvisionVM(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvisionView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.infrastructure.virtual_machines.SetRetirement(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RetirementView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.infrastructure.virtual_machines.Template(name, provider, template_name=None)[source]

Bases: cfme.common.vm.Template

REMOVE_MULTI = 'Remove Templates from the VMDB'
genealogy
class cfme.infrastructure.virtual_machines.TemplatesAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TemplatesOnlyAllView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.infrastructure.virtual_machines.TemplatesOnlyAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.virtual_machines.InfraVmView

adv_search_clear
entities
is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraVmTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.virtual_machines.VMConfiguration(vm)[source]

Bases: utils.pretty.Pretty

Represents VM’s full configuration - hardware, disks and so forth

Parameters:vm – VM that exists within current appliance

Note

It can be only instantiated by fetching an existing VM’s configuration, as it is designed to be used to reconfigure an existing VM.

add_disk(size, size_unit='GB', type='thin', mode='persistent')[source]

Adds a disk to the VM

Parameters:
  • size – Size of the disk
  • size_unit – Unit of size (‘MB’ or ‘GB’)
  • type – Type of the disk (‘thin’ or ‘thick’)
  • mode – Mode of the disk (‘persistent’, ‘independent_persistent’ or ‘independent_nonpersistent’)

Note

This method is designed to correspond with the DB, not with the UI. In the UI, dependency is represented by a separate Yes / No option which is _incorrect_ design that we don’t follow. Correctly, mode should be a selectbox of 3 items: Persistent, Independent Persistent and Independent Nonpersistent. Just Nonpersistent is an invalid setup that UI currently (5.8) allows.

copy()[source]

Returns a copy of this configuration

delete_disk(filename=None, index=None)[source]

Removes a disk of given filename or index

get_changes_to_fill(other_configuration)[source]

Returns changes to be applied to this config to reach the other config

Note

Result of this method is used for form filling by VM’s reconfigure method.

num_disks
pretty_attrs = ['hw', 'num_disks']
class cfme.infrastructure.virtual_machines.VMDisk[source]

Bases: cfme.infrastructure.virtual_machines.VMDisk

Represents a single VM disk

Note

Cannot be changed once created.

EQUAL_ATTRS = set(['size_mb', 'type', 'mode'])
size_mb
class cfme.infrastructure.virtual_machines.VMHardware(cores_per_socket=None, sockets=None, mem_size=None, mem_size_unit='MB')[source]

Bases: object

Represents VM’s hardware, i.e. CPU (cores, sockets) and memory

EQUAL_ATTRS = set(['mem_size_mb', 'cores_per_socket', 'sockets'])
mem_size_mb
class cfme.infrastructure.virtual_machines.Vm(name, provider, template_name=None, appliance=None)[source]

Bases: cfme.common.vm.VM

Represents a VM in CFME

Parameters:
  • name – Name of the VM
  • provider_crud – cfme.cloud.provider.Provider object
  • template_name – Name of the template to use for provisioning
ALL_LIST_LOCATION = 'infra_vms'
class CfmeRelationship(o)[source]

Bases: object

get_relationship()[source]
is_relationship_set()[source]
navigate()[source]
relationship_form = <cfme.web_ui.Form fields=[('server_select', <cfme.web_ui.AngularSelect _loc="//button[@data-id='server_id']", none=None, multi=False, exact=False>), ('save_button', FormButton('Save Changes')), ('reset_button', FormButton('Reset Changes')), ('cancel_button', FormButton('Cancel'))]>
set_relationship(server_name, server_id, click_cancel=False)[source]
Vm.GUEST_RESTART = 'Restart Guest'
Vm.GUEST_SHUTDOWN = 'Shutdown Guest'
Vm.POWER_OFF = 'Power Off'
Vm.POWER_ON = 'Power On'
Vm.RESET = 'Reset'
Vm.STATE_OFF = 'off'
Vm.STATE_ON = 'on'
Vm.STATE_SUSPENDED = 'suspended'
Vm.SUSPEND = 'Suspend'
class Vm.Snapshot(name=None, description=None, memory=None, parent_vm=None)[source]

Bases: object

active

Check if the snapshot is active.

Returns:True if snapshot is active, False otherwise.
Return type:bool
create(force_check_memory=False)[source]
delete(cancel=False)[source]
delete_all(cancel=False)[source]
exists
refresh()[source]
revert_to(cancel=False)[source]
snapshot_tree = <cfme.web_ui.BootstrapTreeview object>
Vm.TO_OPEN_EDIT = 'Edit this VM'
Vm.TO_OPEN_RECONFIGURE = 'Reconfigure this VM'
Vm.TO_RETIRE = 'Retire this VM'
Vm.VM_TYPE = 'Virtual Machine'
Vm.clone_vm(email=None, first_name=None, last_name=None, vm_name=None, provision_type=None)[source]
Vm.cluster_id

returns id of cluster current vm belongs to

Vm.configuration
Vm.current_snapshot_description

Returns the current snapshot description.

Vm.current_snapshot_name

Returns the current snapshot name.

Vm.genealogy
Vm.get_collection_via_rest()[source]
Vm.get_vm_via_rest()[source]
Vm.migrate_vm(email=None, first_name=None, last_name=None, host_name=None, datastore_name=None)[source]
Vm.power_control_from_provider(option)[source]

Power control a vm from the provider

Parameters:option – power control action to take against vm
Raises:OptionNotAvailable – option parm must have proper value
Vm.publish_to_template(template_name, email=None, first_name=None, last_name=None)[source]
Vm.reconfigure(new_configuration=None, changes=None, cancel=False)[source]

Reconfigures the VM based on given configuration or set of changes

Parameters:
  • new_configuration – VMConfiguration object with desired configuration
  • changes – Set of changes to request; alternative to new_configuration See VMConfiguration.get_changes_to_fill to see expected format of the data
  • cancel – False if we want to submit the changes, True otherwise
Vm.total_snapshots

Returns the number of snapshots for this VM. If it says None, returns 0.

class cfme.infrastructure.virtual_machines.VmAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of VmsOnlyAllView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)[source]
step(*args, **kwargs)[source]
class cfme.infrastructure.virtual_machines.VmAllWithTemplates(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of VmsTemplatesAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)[source]
step()[source]
class cfme.infrastructure.virtual_machines.VmAllWithTemplatesDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraVmDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)[source]
step()[source]
class cfme.infrastructure.virtual_machines.VmAllWithTemplatesForProvider(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of VmTemplatesAllForProviderView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)[source]
step(*args, **kwargs)[source]
class cfme.infrastructure.virtual_machines.VmClone(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvisionView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.infrastructure.virtual_machines.VmDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraVmDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)[source]
step(*args, **kwargs)[source]
class cfme.infrastructure.virtual_machines.VmEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.virtual_machines.VmEngineRelationship(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ManagementEngineView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.virtual_machines.VmMigrate(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MigrateView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.infrastructure.virtual_machines.VmReconfigure(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InfraVmReconfigureView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.infrastructure.virtual_machines.VmTemplatesAllForProviderView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.virtual_machines.InfraVmView

adv_search_clear
entities
is_displayed
reset_page()[source]
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.VmsOnlyAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.virtual_machines.InfraVmView

adv_search_clear
entities
is_displayed
reset_page()[source]
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.VmsTemplatesAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

The accordion on the Virtual Machines page

templates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vms

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vmstemplates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.infrastructure.virtual_machines.VmsTemplatesAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.infrastructure.virtual_machines.InfraVmView

The collection page for instances

adv_search_clear
entities
is_displayed
pagination

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_page()[source]
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.infrastructure.virtual_machines.do_power_control(vm_names, option, provider_crud=None, cancel=True)[source]

Executes a power option against a list of VMs.

Parameters:
  • vm_names – List of VMs to interact with
  • option – Power option param.
  • provider_crud – provider object where vm resides on (optional)
  • cancel – Whether or not to cancel the power control action
cfme.infrastructure.virtual_machines.find_quadicon(vm_name)[source]

Find and return a quadicon belonging to a specific vm

Parameters:vm – vm name as displayed at the quadicon

Returns: entity of appropriate class

cfme.infrastructure.virtual_machines.get_all_vms(do_not_navigate=False)[source]

Returns list of all vms

cfme.infrastructure.virtual_machines.get_number_of_vms(do_not_navigate=False)[source]

Returns the total number of VMs visible to the user, including those archived or orphaned

cfme.infrastructure.virtual_machines.is_pwr_option_enabled(vm_names, option, provider_crud=None)[source]

Returns whether a particular power option is enabled.

Parameters:
  • vm_names – List of VMs to interact with
  • provider_crud – provider object where vm resides on (optional)
  • option – Power option param.
Raises:

NoOptionAvailable

When unable to find the power option passed
cfme.infrastructure.virtual_machines.is_pwr_option_visible(vm_names, option, provider_crud=None)[source]

Returns whether a particular power option is visible.

Parameters:
  • vm_names – List of VMs to interact with, if from_details=True is passed, only one VM can be passed in the list.
  • option – Power option param.
  • provider_crud – provider object where vm resides on (optional)
cfme.infrastructure.virtual_machines.perform_smartstate_analysis(vm_names, provider_crud=None, cancel=True)[source]

Executes a refresh relationships action against a list of VMs.

Parameters:
  • vm_names – List of VMs to interact with
  • provider_crud – provider object where vm resides on (optional)
  • cancel – Whether or not to cancel the refresh relationships action
cfme.infrastructure.virtual_machines.remove(vm_names, cancel=True, provider_crud=None)[source]

Removes multiple VMs from CFME VMDB

Parameters:
  • vm_names – List of VMs to interact with
  • cancel – Whether to cancel the deletion, defaults to True
  • provider_crud – provider object where vm resides on (optional)
cfme.infrastructure.virtual_machines.wait_for_vm_state_change(vm_name, desired_state, timeout=300, provider_crud=None)[source]

Wait for VM to come to desired state.

This function waits just the needed amount of time thanks to wait_for.

Parameters:
  • vm_name – Displayed name of the VM
  • desired_state – ‘on’ or ‘off’
  • timeout – Specify amount of time (in seconds) to wait until TimedOutError is raised
  • provider_crud – provider object where vm resides on (optional)
Module contents
cfme.intelligence package
Subpackages
cfme.intelligence.chargeback package
Submodules
cfme.intelligence.chargeback.assignments module
class cfme.intelligence.chargeback.assignments.Assign(assign_to=None, tag_category=None, docker_labels=None, selections=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Model of Chargeback Assignment page in cfme.

Parameters:
  • assign_to – Assign the chargeback rate to entities such as VM,Provider,datastore or the Enterprise itself.
  • tag_category – Tag category of the entity
  • selections – Selection of a particular entity to which the rate is to be assigned. Eg:If the chargeback rate is to be assigned to providers,select which of the managed providers the rate is to be assigned.

Usage:

enterprise = Assign(
assign_to="The Enterprise",
selections={
    'Enterprise': {'Rate': 'Default'}
})

enterprise.computeassign()

computeassign()[source]
storageassign()[source]
class cfme.intelligence.chargeback.assignments.AssignAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AssignmentsAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.assignments.AssignCompute(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AssignmentsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.assignments.AssignStorage(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AssignmentsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.assignments.AssignmentsAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.ChargebackView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.chargeback.assignments.AssignmentsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.ChargebackView

assign_to

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

docker_labels

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

selections

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tag_category

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.intelligence.chargeback.rates module
class cfme.intelligence.chargeback.rates.AddComputeChargebackView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.rates.RatesView

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

currency

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

fields

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.chargeback.rates.AddStorageChargebackView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.rates.AddComputeChargebackView

is_displayed
class cfme.intelligence.chargeback.rates.ComputeRate(description=None, currency=None, fields=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

This class represents a Compute Chargeback rate.

Example

>>> import cfme.intelligence.chargeback.rates as rates
>>> rate = rates.ComputeRate(description=desc,
          fields={'Used CPU':
                  {'per_time': 'Hourly', 'variable_rate': '3'},
                  'Used Disk I/O':
                  {'per_time': 'Hourly', 'variable_rate': '2'},
                  'Used Memory':
                  {'per_time': 'Hourly', 'variable_rate': '2'}})
>>> rate.create()
>>> rate.delete()
Parameters:
  • description – Rate description
  • currency – Rate currency
  • fields – Rate fields
create()[source]
delete()[source]
pretty_attrs = ['description']
update(updates)[source]
class cfme.intelligence.chargeback.rates.ComputeRateAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RatesView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.rates.ComputeRateDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RatesDetailView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.rates.ComputeRateEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditComputeChargebackView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.rates.ComputeRateNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddComputeChargebackView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.rates.EditComputeChargebackView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.rates.AddComputeChargebackView

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.chargeback.rates.EditStorageChargebackView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.rates.EditComputeChargebackView

is_displayed
class cfme.intelligence.chargeback.rates.RatesDetailView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.ChargebackView

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.chargeback.rates.RatesView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.ChargebackView

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.chargeback.rates.StorageChargebackView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.chargeback.rates.RatesView

is_displayed
class cfme.intelligence.chargeback.rates.StorageRate(description=None, currency=None, fields=None, appliance=None)[source]

Bases: cfme.intelligence.chargeback.rates.ComputeRate

pretty_attrs = ['description']
class cfme.intelligence.chargeback.rates.StorageRateAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of StorageChargebackView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.rates.StorageRateDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RatesDetailView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.rates.StorageRateEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditStorageChargebackView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.chargeback.rates.StorageRateNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddStorageChargebackView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
Module contents
class cfme.intelligence.chargeback.ChargebackView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

assignments

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_chargeback
is_displayed
rates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reports

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.chargeback.IntelChargeback(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ChargebackView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.intelligence.reports package
Subpackages
cfme.intelligence.reports.widgets package
Submodules
cfme.intelligence.reports.widgets.chart_widgets module

Page model for Cloud Intel / Reports / Dashboard Widgets / Charts

class cfme.intelligence.reports.widgets.chart_widgets.ChartWidget(title, description=None, active=None, filter=None, timer=None, visibility=None)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardReportWidget

TITLE = 'Chart'
TYPE = 'Charts'
fill_dict
pretty_attrs = ['title', 'description', 'filter', 'visibility']
class cfme.intelligence.reports.widgets.chart_widgets.ChartWidgetFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardWidgetFormCommon

every

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

filter

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

run

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_date

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_hour

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_minute

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

time_zone

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.widgets.chart_widgets.EditChartWidget(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseEditDashboardWidgetStep

VIEW

alias of EditChartWidgetView

class cfme.intelligence.reports.widgets.chart_widgets.EditChartWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseEditDashboardWidgetView, cfme.intelligence.reports.widgets.chart_widgets.ChartWidgetFormCommon

class cfme.intelligence.reports.widgets.chart_widgets.NewChartWidget(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseNewDashboardWidgetStep

VIEW

alias of NewChartWidgetView

class cfme.intelligence.reports.widgets.chart_widgets.NewChartWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseNewDashboardWidgetView, cfme.intelligence.reports.widgets.chart_widgets.ChartWidgetFormCommon

cfme.intelligence.reports.widgets.menu_widgets module

Page model for Cloud Intel / Reports / Dashboard Widgets / Menus

class cfme.intelligence.reports.widgets.menu_widgets.EditMenuWidget(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseEditDashboardWidgetStep

VIEW

alias of EditMenuWidgetView

class cfme.intelligence.reports.widgets.menu_widgets.EditMenuWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseEditDashboardWidgetView, cfme.intelligence.reports.widgets.menu_widgets.MenuWidgetFormCommon

class cfme.intelligence.reports.widgets.menu_widgets.MenuWidget(title, description=None, active=None, shortcuts=None, visibility=None)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardReportWidget

TITLE = 'Menu'
TYPE = 'Menus'
fill_dict
pretty_attrs = ['description', 'shortcuts', 'visibility']
class cfme.intelligence.reports.widgets.menu_widgets.MenuWidgetFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardWidgetFormCommon

menu_shortcuts

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.widgets.menu_widgets.NewMenuWidget(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseNewDashboardWidgetStep

VIEW

alias of NewMenuWidgetView

class cfme.intelligence.reports.widgets.menu_widgets.NewMenuWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseNewDashboardWidgetView, cfme.intelligence.reports.widgets.menu_widgets.MenuWidgetFormCommon

cfme.intelligence.reports.widgets.report_widgets module

Page model for Cloud Intel / Reports / Dashboard Widgets / Reports

class cfme.intelligence.reports.widgets.report_widgets.EditReportWidget(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseEditDashboardWidgetStep

VIEW

alias of EditReportWidgetView

class cfme.intelligence.reports.widgets.report_widgets.EditReportWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseEditDashboardWidgetView, cfme.intelligence.reports.widgets.report_widgets.ReportWidgetFormCommon

class cfme.intelligence.reports.widgets.report_widgets.NewReportWidget(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseNewDashboardWidgetStep

VIEW

alias of NewReportWidgetView

class cfme.intelligence.reports.widgets.report_widgets.NewReportWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseNewDashboardWidgetView, cfme.intelligence.reports.widgets.report_widgets.ReportWidgetFormCommon

class cfme.intelligence.reports.widgets.report_widgets.ReportWidget(title, description=None, active=None, filter=None, columns=None, rows=None, timer=None, visibility=None)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardReportWidget

TITLE = 'Report'
TYPE = 'Reports'
fill_dict
pretty_attrs = ['description', 'filter', 'visibility']
class cfme.intelligence.reports.widgets.report_widgets.ReportWidgetFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardWidgetFormCommon

column1

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

column2

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

column3

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

column4

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

every

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

filter

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

repfilter

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

row_count

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

run

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_date

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_hour

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_minute

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

subfilter

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

time_zone

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.intelligence.reports.widgets.rss_widgets module

Page model for Cloud Intel / Reports / Dashboard Widgets / RSS Feeds

class cfme.intelligence.reports.widgets.rss_widgets.EditRSSWidget(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseEditDashboardWidgetStep

VIEW

alias of EditRSSWidgetView

class cfme.intelligence.reports.widgets.rss_widgets.EditRSSWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseEditDashboardWidgetView, cfme.intelligence.reports.widgets.rss_widgets.RSSWidgetFormCommon

class cfme.intelligence.reports.widgets.rss_widgets.NewRSSWidget(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseNewDashboardWidgetStep

VIEW

alias of NewRSSWidgetView

class cfme.intelligence.reports.widgets.rss_widgets.NewRSSWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseNewDashboardWidgetView, cfme.intelligence.reports.widgets.rss_widgets.RSSWidgetFormCommon

class cfme.intelligence.reports.widgets.rss_widgets.RSSFeedWidget(title, description=None, active=None, type=None, feed=None, external=None, rows=None, timer=None, visibility=None)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardReportWidget

TITLE = 'RSS Feed'
TYPE = 'RSS Feeds'
fill_dict
pretty_attrs = ['title', 'description', 'type', 'feed', 'visibility']
class cfme.intelligence.reports.widgets.rss_widgets.RSSWidgetFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardWidgetFormCommon

every

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

external

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

rows

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

run

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_date

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_hour

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_minute

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

time_zone

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

url

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents

Page model for Cloud Intel / Reports / Dashboard Widgets

class cfme.intelligence.reports.widgets.AllDashboardWidgetsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.DashboardWidgetsView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.widgets.BaseDashboardReportWidget(*args, **kwargs)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

TITLE = None
TYPE = None
check_status()[source]
create()[source]

Create this Widget in the UI.

delete(cancel=False)[source]

Delete this Widget in the UI.

Parameters:cancel – Whether to cancel the deletion (default False).
generate(wait=True, cancel=False, **kwargs)[source]
pretty_attrs = []
refresh()[source]
update(updates)[source]

Update this Widget in the UI.

Parameters:
  • updates – Provided by update() context manager.
  • cancel – Whether to cancel the update (default False).
wait_generated(timeout=600)[source]
class cfme.intelligence.reports.widgets.BaseDashboardWidgetDetailsStep(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DashboardWidgetDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.widgets.BaseDashboardWidgetFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.DashboardWidgetsView

active

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

visibility

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

widget_title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.widgets.BaseEditDashboardWidgetStep(obj, navigate_obj)[source]

Bases: cfme.intelligence.reports.widgets.BaseDashboardWidgetDetailsStep

step()[source]
class cfme.intelligence.reports.widgets.BaseEditDashboardWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.DashboardWidgetsView

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.widgets.BaseNewDashboardWidgetStep(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW = None
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.widgets.BaseNewDashboardWidgetView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.DashboardWidgetsView

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.intelligence.reports.widgets.DashboardWidgetDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.widgets.DashboardWidgetsView

is_displayed
reload_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

status_info

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.widgets.DashboardWidgetsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

in_dashboard_widgets
is_displayed
Submodules
cfme.intelligence.reports.dashboards module

Page model for Cloud Intel / Reports / Dashboards

class cfme.intelligence.reports.dashboards.Dashboard(name, group, title=None, locked=None, widgets=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

create(cancel=False)[source]

Create this Dashboard in the UI.

delete(cancel=False)[source]

Delete this Dashboard in the UI.

Parameters:cancel – Whether to cancel the deletion (default False).
group
pretty_attrs = ['name', 'group', 'title', 'widgets']
update(updates)[source]

Update this Dashboard in the UI.

Parameters:updates – Provided by update() context manager.
class cfme.intelligence.reports.dashboards.DashboardAllGroupsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.dashboards.DashboardDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DashboardDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.dashboards.DashboardDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

ITEM_TITLE_LOCATOR = ".//h3[contains(@class, 'panel-title')]"
SAMPLE_DASHBOARD_ROOT = ".//div[@id='modules']"
is_displayed
name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

selected_items
tab_title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.dashboards.DashboardEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditDashboardView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.dashboards.DashboardFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

basic_information

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

locked

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

sample_dashboard

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tab_title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

widgets

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.dashboards.DashboardNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewDashboardView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.dashboards.DefaultDashboard(title='Default Dashboard', locked=None, widgets=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

name

Name of Default Dashboard cannot be changed.

pretty_attrs = ['name', 'title', 'widgets']
update(updates)[source]

Update Default Dashboard in the UI.

Parameters:updates – Provided by update() context manager.
class cfme.intelligence.reports.dashboards.DefaultDashboardDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DefaultDashboardDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.dashboards.DefaultDashboardDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.dashboards.DashboardDetailsView

is_displayed
class cfme.intelligence.reports.dashboards.DefaultDashboardEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditDefaultDashboardView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.dashboards.EditDashboardView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.dashboards.DashboardFormCommon

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.dashboards.EditDefaultDashboardView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.dashboards.EditDashboardView

is_displayed
class cfme.intelligence.reports.dashboards.NewDashboardView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.dashboards.DashboardFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
cfme.intelligence.reports.import_export module
class cfme.intelligence.reports.import_export.ImportExportCommonForm(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

export_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

items_for_export

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

subtitle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

upload_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

upload_file

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.import_export.ImportExportCustomReports(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ImportExportCustomReportsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.import_export.ImportExportCustomReportsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.import_export.ImportExportCommonForm

is_displayed
overwrite

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.import_export.ImportExportWidgets(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ImportExportWidgetsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.import_export.ImportExportWidgetsCommitView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

commit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.import_export.ImportExportWidgetsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.import_export.ImportExportCommonForm

is_displayed
class cfme.intelligence.reports.import_export.InputButton(parent, name=None, id=None, locator=None, logger=None)[source]

Bases: widgetastic_patternfly.Input, widgetastic.widget.ClickableMixin

cfme.intelligence.reports.import_export.export_reports(*custom_report_names)[source]
cfme.intelligence.reports.import_export.export_widgets(*widget_names)[source]
cfme.intelligence.reports.import_export.import_reports(filename, overwrite=False)[source]
cfme.intelligence.reports.import_export.import_widgets(filename, overwrite=False)[source]
cfme.intelligence.reports.menus module

Module handling report menus contents

class cfme.intelligence.reports.menus.EditReportMenus(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditReportMenusView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.menus.EditReportMenusView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

commit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

default_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

discard_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
manager

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

report_select

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reports_tree

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.menus.ReportMenu(appliance=None)[source]

Bases: utils.appliance.Navigatable

This is a fake class mainly needed for navmazing navigation.

add_folder(group, folder)[source]

Adds a folder under top-level.

Parameters:
  • group – User group.
  • folder – Name of the new folder.
add_subfolder(group, folder, subfolder)[source]

Adds a subfolder under specified folder.

Parameters:
  • group – User group.
  • folder – Name of the folder.
  • subfolder – Name of the new subdfolder.
get_folders(group)[source]

Returns list of folders for given user group.

Parameters:group – User group to check.
get_subfolders(group, folder)[source]

Returns list of sub-folders for given user group and folder.

Parameters:
  • group – User group to check.
  • folder – Folder to read.
go_to_group(group_name)[source]
manage_folder(*args, **kwds)[source]

Context manager to use when modifying the folder contents.

You can use manager’s FolderManager.bail_out() classmethod to end and discard the changes done inside the with block. This context manager does not give the manager as a value to the with block so you have to import and use the FolderManager class manually.

Parameters:
  • group – User group.
  • folder – Which folder to manage. If None, top-level will be managed.

Returns: Context-managed widgetastic_manageiq.FolderManager instance

manage_subfolder(*args, **kwds)[source]

Context manager to use when modifying the subfolder contents.

You can use manager’s FolderManager.bail_out() classmethod to end and discard the changes done inside the with block.

Parameters:
  • group – User group.
  • folder – Parent folder name.
  • subfolder – Subfolder name to manage.

Returns: Context-managed :py:class: widgetastic_manageiq.MultiBoxSelect instance

reset_to_default(group)[source]

Clicks the Default button.

Parameters:group – Group to set to Default
cfme.intelligence.reports.reports module

Page model for Cloud Intel / Reports / Reports

class cfme.intelligence.reports.reports.AllCustomReportsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.reports.AllReportsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

is_displayed
reports_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.reports.CannedReportInfo(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CannedReportView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.reports.CannedReportView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.reports.CustomReportDetailsView

is_displayed
class cfme.intelligence.reports.reports.CannedSavedReport(path_to_report, run_datetime, queued_datetime, candu=False, appliance=None)[source]

Bases: cfme.intelligence.reports.reports.CustomSavedReport, utils.appliance.Navigatable

As we cannot create or edit canned reports, we don’t know their titles and so, so we need to change the navigation a little bit for it to work correctly.

Parameters:
  • path_to_report – Iterable with path to report.
  • datetime – Datetime of “Run At” of the report. That’s what queue_canned_report() returns.
delete(cancel=False)[source]
delete_if_exists()[source]
exists
get_saved_canned_reports(*path)[source]
navigate()[source]
classmethod new(path)[source]
classmethod queue_canned_report(path)[source]

Queue report from selection of pre-prepared reports.

Parameters:*path – Path in tree after All Reports

Returns: Value of Run At in the table so the run can be then checked.

class cfme.intelligence.reports.reports.CannedSavedReportDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CannedSavedReportView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.reports.CannedSavedReportView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.reports.CustomSavedReportDetailsView

is_displayed
class cfme.intelligence.reports.reports.CustomReport(appliance=None, **values)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable

create(cancel=False)[source]
delete(cancel=False)[source]
get_saved_reports()[source]
queue(wait_for_finish=False)[source]
update(updates)[source]
class cfme.intelligence.reports.reports.CustomReportAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AllReportsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.reports.CustomReportDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CustomReportDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.reports.CustomReportDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

is_displayed
reload_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

report_info

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

saved_reports

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.reports.CustomReportEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditCustomReportView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.reports.CustomReportFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

base_report_on

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_after

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

charts

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

consolidation

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

filter

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

formatting

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

menu_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

report_fields

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

report_title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

styling

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

summary

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

timeline

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.reports.CustomReportNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewCustomReportView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.reports.CustomSavedReport(report, run_datetime, queued_datetime, candu=False, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Custom Saved Report. Enables us to retrieve data from the table.

Parameters:
  • report – Report that we have data from.
  • run_datetime – Datetime of “Run At” of the report. That’s what queue() returns.
  • queued_datetime – Datetime of “Queued At” of the report.
  • candu – If it is a C&U report, in that case it uses a different table.
data

Retrieves data from the saved report.

Returns: SavedReportData.

download(extension)[source]
pretty_attrs = ['report', 'run_datetime', 'queued_datetime']
class cfme.intelligence.reports.reports.CustomSavedReportDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CustomSavedReportDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.reports.CustomSavedReportDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.reports.EditCustomReportView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.reports.CustomReportFormCommon

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.reports.NewCustomReportView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.reports.CustomReportFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.intelligence.reports.reports.SavedReportData(headers, body)[source]

Bases: utils.pretty.Pretty

This class stores data retrieved from saved report.

Parameters:
  • headers – Tuple with header columns.
  • body – List of tuples with body rows.
find_cell(column, value, cell)[source]
find_row(column, value)[source]
pretty_attrs = ['headers', 'body']
rows
cfme.intelligence.reports.saved module
class cfme.intelligence.reports.saved.AllSavedReportsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.saved.SavedReport(name, run_at_datetime, queued_datetime_in_title, appliance=None)[source]

Bases: utils.appliance.Navigatable

delete(cancel=False)[source]
class cfme.intelligence.reports.saved.SavedReportDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.reports.CustomSavedReportDetailsView

is_displayed
class cfme.intelligence.reports.saved.SavedReportView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.saved.AllSavedReportsView

is_displayed
class cfme.intelligence.reports.saved.ScheduleDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SavedReportDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.intelligence.reports.schedules module

Module handling schedules

class cfme.intelligence.reports.schedules.EditScheduleView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.schedules.SchedulesFormCommon

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.schedules.NewScheduleView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.schedules.SchedulesFormCommon

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.intelligence.reports.schedules.Schedule(name, description, filter, active=None, timer=None, emails=None, email_options=None, collection=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

Represents a schedule in Cloud Intel/Reports/Schedules.

Parameters:
  • name – Schedule name.
  • description – Schedule description.
  • filter – 3-tuple with filter selection (see the UI).
  • active – Whether is this schedule active.
  • run – Specifies how often this schedule runs. It can be either string “Once”, or a tuple, which maps to the two selects in UI (“Hourly”, “Every hour”)...
  • time_zone – Specify time zone.
  • start_date – Specify the start date.
  • start_time – Specify the start time either as a string (“0:15”) or tuple (“0”, “15”)
  • send_email – If specifies, turns on e-mail sending. Can be string, or list or set.
delete(cancel=False)[source]
exists
pretty_attrs = ['name', 'filter']
queue()[source]

Queue this schedule.

update(updates)[source]
class cfme.intelligence.reports.schedules.ScheduleAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SchedulesAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.schedules.ScheduleCollection(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

create(name=None, description=None, filter=None, active=None, timer=None, emails=None, email_options=None)[source]
delete_schedules(*schedules, **kwargs)[source]

Select and delete specified schedules from VMDB.

Parameters:
  • *schedules – Schedules to delete. Can be objects or strings.
  • cancel – (kwarg) Whether to cancel the deletion (Default: False)

Raises: NameError when some of the schedules were not found.

disable_schedules(*schedules)[source]

Select and disable specified schedules.

Parameters:*schedules – Schedules to disable. Can be objects or strings.

Raises: NameError when some of the schedules were not found.

enable_schedules(*schedules)[source]

Select and enable specified schedules.

Parameters:*schedules – Schedules to enable. Can be objects or strings.

Raises: NameError when some of the schedules were not found.

instantiate(name, description, filter, active=None, timer=None, emails=None, email_options=None)[source]
queue_schedules(*schedules)[source]

Select and queue specified schedules.

Parameters:*schedules – Schedules to queue. Can be objects or strings.

Raises: NameError when some of the schedules were not found.

class cfme.intelligence.reports.schedules.ScheduleDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ScheduleDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.schedules.ScheduleDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.schedules.ScheduleEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditScheduleView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.schedules.ScheduleNew(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NewScheduleView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.schedules.SchedulesAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
schedules_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.schedules.SchedulesFormCommon(parent, logger=None, **kwargs)[source]

Bases: cfme.intelligence.reports.CloudIntelReportsView

active

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

emails

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

emails_send

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

filter1

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

filter2

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

filter3

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hour

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

minute

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

run

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

send_csv

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

send_if_empty

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

send_pdf

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

send_txt

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

starting_date

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

time_zone

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents
class cfme.intelligence.reports.CloudIntelReports(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudIntelReportsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.intelligence.reports.CloudIntelReportsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

dashboard_widgets

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

dashboards

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

edit_report_menus

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

import_export

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_intel_reports
is_displayed
reports

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

saved_reports

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

schedules

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.intelligence.reports.ReportsMultiBoxSelect(parent, move_into=None, move_from=None, available_items=None, chosen_items=None, logger=None)[source]

Bases: widgetastic_manageiq.MultiBoxSelect

move_from_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

move_into_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Submodules
cfme.intelligence.rss module
class cfme.intelligence.rss.RSSView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

is_displayed
Module contents

This is a directory of modules, each one represents one menu sub-item.

cfme.metaplugins package
Submodules
cfme.metaplugins.blockers module

A generalized framowork for handling test blockers.

Currently handling Bugzilla nad GitHub issues. For extensions, see this file and utils.blockers.

If you want to mark test with blockers, use meta mark blockers and specify a list of the blockers. The blockers can be directly the objects of utils.blockers.Blocker subclasses, but you can use just plain strings that will get resolved into the objects when required.

Example comes:

@pytest.mark.meta(
    blockers=[
        BZ(123456),             # Will get resolved to BZ obviously
        GH(1234),               # Will get resolved to GH if you have default repo set
        GH("owner/repo:issue"), # Otherwise you need to use this syntax
        # Generic blocker writing - (<engine_name>#<blocker_spec>)
        # These work for any engine that is in :py:mod:`utils.blockers`
        "BZ#123456",            # Will resolve to BZ
        "GH#123",               # Will resolve to GH (needs default repo specified)
        "GH#owner/repo:123",    # Will resolve to GH
        # Shortcut writing
        123456,                 # Will resolve to BZ
    ]
)

Íf you want to unskip, then you have to use the full object (BZ()) and pass it a kwarg called unblock. When the function in unblock resolves to a truthy value, the test won’t be skipped. If the blocker does not block, the unblock is not called. There is also a custom_action that will get called if the blocker blocks. if the action does nothing, then it continues with next actions etc., until it gets to the point that it skips the test because there are blockers.

cfme.metaplugins.blockers.kwargify(f)[source]

Convert function having only positional args to a function taking dictionary.

If you pass False or None, a function which always returns False is returned. If you pass True, a function which always returns True is returned.

cfme.metaplugins.blockers.resolve_blockers(item, blockers)[source]
cfme.metaplugins.server_roles module

Set server roles based on a list of roles attached to the test using metadata plugin.

If you want to specify certain roles that have to be set, you can use this type of decoration:

@pytest.mark.meta(server_roles="+automate")
def test_appliance_roles():
    assert foo

This takes the current list from cfme_data.yaml and modifies it by the server_roles keyword. If prefixed with + or nothing, it adds, if prefixed with -, it removes the role. It can be combined either in string and in list, so these lines are functionally equivalent:

"+automate -foo bar" # (add automate and bar, remove foo)
["+automate", "-foo", "bar"]

If you specify the server_roles as None, then all roles are flushed and the list contains only user_interface role.

Roles can be pulled from the cfme_data fixture using yaml selectors, which will do a ‘set’ with the list of roles found at the target path:

@pytest.mark.meta(server_roles=('level1', 'sublevel2'), server_roles_mode='cfmedata')
def test_appliance_roles():
    assert len(get_server_roles()) == 3

Which corresponds to this yaml layout:

level1:
    sublevel2:
        - database_operations
        - user_interface
        - web_services

To ensure the appliance has the default roles:

@pytest.mark.fixtureconf(server_roles="default")
def test_appliance_roles():
    do(test)

For a list of server role names currently exposed in the CFME interface, see keys of cfme.configure.configuration.server_roles.

cfme.metaplugins.server_roles.add_server_roles(server_roles, server_roles_mode='add')[source]
cfme.metaplugins.skip module

I missed callable based skipper so here it is.

cfme.metaplugins.skip.skip_plugin(item, skip, reason='Skipped')[source]
Module contents
cfme.middleware package
Subpackages
cfme.middleware.provider package
Submodules
cfme.middleware.provider.hawkular module
class cfme.middleware.provider.hawkular.HawkularProvider(name=None, hostname=None, port=None, credentials=None, key=None, appliance=None, sec_protocol=None, **kwargs)[source]

Bases: cfme.middleware.provider.MiddlewareBase, cfme.common.TopologyMixin, cfme.common.TimelinesMixin, cfme.middleware.provider.MiddlewareProvider

HawkularProvider class holds provider data. Used to perform actions on hawkular provider page

Parameters:
  • name – Name of the provider
  • hostname – Hostname/IP of the provider
  • port – http/https port of hawkular provider
  • credentials – see Credential inner class.
  • key – The CFME key of the provider in the yaml.
  • db_id – database row id of provider

Usage:

myprov = HawkularProvider(name='foo',
                    hostname='localhost',
                    port=8080,
                    credentials=Provider.Credential(principal='admin', secret='foobar')))
myprov.create()
myprov.num_deployment(method="ui")
STATS_TO_MATCH = ['num_server', 'num_domain', 'num_deployment', 'num_datasource', 'num_messaging']
db_types = ['Hawkular::MiddlewareManager']
classmethod download(extension)[source]
static from_config(prov_config, prov_key, appliance=None)[source]
is_refreshed(*args, **kwargs)
is_refreshed_db = None
load_details(refresh=False)[source]

Call super class load_details and load db_id if not set

load_timelines_page()[source]
load_topology_page()[source]
mgmt_class = <Mock name='mock.Hawkular' id='139657550535120'>
num_datasource(*args, **kwargs)
num_datasource_ui = None
num_deployment(*args, **kwargs)
num_deployment_ui = None
num_domain(*args, **kwargs)
num_domain_ui = None
num_messaging(*args, **kwargs)
num_messaging_ui = None
num_server(*args, **kwargs)
num_server_group(*args, **kwargs)
num_server_ui = None
property_tuples = [('name', 'Name'), ('hostname', 'Host Name'), ('port', 'Port'), ('provider_type', 'Type')]
recheck_auth_status()[source]
type_name = 'hawkular'
Module contents
class cfme.middleware.provider.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.middleware.provider.Container[source]

Bases: cfme.common.SummaryMixin

add_datasource(ds_type, ds_name, jndi_name, ds_url, xa_ds=False, driver_name=None, existing_driver=None, driver_module_name=None, driver_class=None, username=None, password=None, sec_domain=None, cancel=False)[source]

Clicks to “Add Datasource” button, in opened window fills fields by provided parameter by clicking ‘Next’, and submits the form by clicking ‘Finish’.

Parameters:
  • ds_type – Type of database.
  • ds_name – Name of newly created Datasource.
  • jndi_name – JNDI Name of Datasource.
  • driver_name – JDBC Driver name in Datasource.
  • driver_module_name – Module name of JDBC Driver used in datasource.
  • driver_class – JDBC Driver Class.
  • ds_url – Database connection URL in jdbc format.
  • username – Database username.
  • password – Databasae password, optional.
  • sec_domain – Security Domain, optional.
  • cancel – Whether to click Cancel instead of commit.
add_deployment(filename, runtime_name=None, enable_deploy=True, overwrite=False, cancel=False)[source]

Clicks to “Add Deployment” button, in opened window fills fields by provided parameters, and deploys.

Parameters:
  • filename – Full path to file to import.
  • runtime_name – Runtime name of deployment archive.
  • enable_deploy – Whether to enable deployment archive or keep disabled.
  • cancel – Whether to click Cancel instead of commit.
add_jdbc_driver(filename, driver_name, module_name, driver_class, xa_class=None, major_version=None, minor_version=None, cancel=False)[source]

Clicks to “Add JDBC Driver” button, in opened window fills fields by provided parameters, and deploys.

Parameters:
  • filename – Full path to JDBC Driver to import.
  • driver_name – Name of newly created JDBC Driver.
  • module_name – Name on Module to register on server side.
  • driver_class – JDBC Driver Class.
  • major_version – Major version of JDBC driver, optional.
  • minor_version – Minor version of JDBC driver, optional.
  • cancel – Whether to click Cancel instead of commit.
class cfme.middleware.provider.Deployable[source]

Bases: cfme.common.SummaryMixin

disable()[source]

Clicks on “Disable” menu item and verifies message shown

enable()[source]

Clicks on “Enable” menu item and verifies message shown

restart()[source]

Clicks on “Restart” menu item and verifies message shown

undeploy()[source]

Clicks on “Undeploy” menu item and verifies message shown

class cfme.middleware.provider.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.EditFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.EditTagsFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.MiddlewareBase[source]

Bases: cfme.common.Validatable

MiddlewareBase class used to define common functions across pages. Also used to override existing function when required.

download_summary()[source]
get_detail(*ident)[source]

Gets details from the details infoblock :param *ident: Table name and Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the summary’s value.

class cfme.middleware.provider.MiddlewareProvider(*args, **kwargs)[source]

Bases: cfme.common.provider.BaseProvider

STATS_TO_MATCH = []
add_provider_button = FormButton('Add')
category = 'middleware'
db_types = ['MiddlewareManager']
detail_page_suffix = 'provider_detail'
edit_page_suffix = 'provider_edit_detail'
in_version = ('5.7', Version('master'))
page_name = 'middleware'
property_tuples = []
provider_types = {}
quad_name = 'middleware'
refresh_text = 'Refresh items and relationships'
save_button = FormButton('Save')
string_name = 'Middleware'
taggable_type = 'ExtManagementSystem'
class cfme.middleware.provider.MiddlewareProviderTimelinesView(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.TimelinesView, cfme.base.login.BaseLoggedInPage

is_displayed
class cfme.middleware.provider.ProviderDatasources(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.ProviderDeployments(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.ProviderDomains(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.ProviderMessagings(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.ProviderServers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.Timelines(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MiddlewareProviderTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.provider.TopologyFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.middleware.provider.download(extension)[source]
cfme.middleware.provider.get_random_list(items, limit)[source]

In tests, when we have big list iterating through each element will take lot of time. To avoid this, select random list with limited numbers

cfme.middleware.provider.get_server_name(path)[source]
cfme.middleware.provider.parse_properties(props)[source]

Parses provided properties in string format into dictionary format. It splits string into lines and splits each line into key and value.

Submodules
cfme.middleware.datasource module
class cfme.middleware.datasource.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.middleware.datasource.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.datasource.MiddlewareDatasource(name, server, provider=None, appliance=None, **kwargs)[source]

Bases: cfme.middleware.provider.MiddlewareBase, cfme.common.Taggable, utils.appliance.Navigatable, cfme.common.UtilizationMixin

MiddlewareDatasource class provides details on datasource page. Class methods available to get existing datasources list

Parameters:
  • name – Name of the datasource
  • provider – Provider object (HawkularProvider)
  • nativeid – Native id (internal id) of datasource
  • server – Server object of the datasource (MiddlewareServer)
  • properties – Datasource driver name, connection URL and JNDI name
  • db_id – database row id of datasource

Usage:

mydatasource = MiddlewareDatasource(name='FooDS',
                        server=ser_instance,
                        provider=haw_provider,
                        properties='ds-properties')
datasources = MiddlewareDatasource.datasources() [or]
datasources = MiddlewareDeployment.datasources(provider=haw_provider) [or]
datasources = MiddlewareDeployment.datasources(provider=haw_provider,server=ser_instance)
datasource(*args, **kwargs)
datasource_in_db = None
datasource_in_mgmt = None
datasource_in_rest = None
classmethod datasources(provider=None, server=None)[source]
classmethod datasources_in_db(server=None, provider=None, strict=True)[source]
classmethod datasources_in_mgmt(provider=None, server=None)[source]
classmethod download(extension, provider=None, server=None)[source]
load_details(refresh=False)[source]
property_tuples = [('name', 'Name'), ('nativeid', 'Nativeid'), ('driver_name', 'Driver Name'), ('jndi_name', 'JNDI Name'), ('connection_url', 'Connection URL'), ('enabled', 'Enabled')]
remove()[source]

Clicks on “Remove” button of “Operations” menu item and verifies message shown

classmethod remove_from_list(datasource)[source]
taggable_type = 'MiddlewareDatasource'
cfme.middleware.deployment module
class cfme.middleware.deployment.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.middleware.deployment.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.deployment.MiddlewareDeployment(name, server, provider=None, appliance=None, **kwargs)[source]

Bases: cfme.middleware.provider.MiddlewareBase, cfme.common.Taggable, utils.appliance.Navigatable, cfme.middleware.provider.Deployable

MiddlewareDeployment class provides details on deployment page. Class methods available to get existing deployments list

Parameters:
  • name – Name of the deployment
  • provider – Provider object (HawkularProvider)
  • server – Server object of the deployment (MiddlewareServer)
  • nativeid – Native id (internal id) of deployment
  • db_id – database row id of deployment

Usage:

mydeployment = MiddlewareDeployment(name='Foo.war',
                        server=ser_instance,
                        provider=haw_provider)

deployments = MiddlewareDeployment.deployments() [or]
deployments = MiddlewareDeployment.deployments(provider=haw_provider) [or]
deployments = MiddlewareDeployment.deployments(provider=haw_provider,server=ser_instance)
deployment(*args, **kwargs)
deployment_in_db = None
deployment_in_mgmt = None
deployment_in_rest = None
classmethod deployments(provider=None, server=None)[source]
classmethod deployments_in_db(server=None, provider=None, strict=True)[source]
classmethod deployments_in_mgmt(provider=None, server=None)[source]
classmethod download(extension, provider=None, server=None)[source]
load_details(refresh=False)[source]
property_tuples = [('name', 'Name'), ('status', 'Status')]
taggable_type = 'MiddlewareDeployment'
cfme.middleware.domain module
class cfme.middleware.domain.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.middleware.domain.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.domain.DomainServerGroups(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.domain.MiddlewareDomain(name, provider=None, appliance=None, **kwargs)[source]

Bases: cfme.middleware.provider.MiddlewareBase, utils.appliance.Navigatable, cfme.common.Taggable

MiddlewareDomain class provides actions and details on Domain page. Class method available to get existing domains list

Parameters:
  • name – name of the domain
  • provider – Provider object (HawkularProvider)
  • product – Product type of the domain
  • feed – feed of the domain
  • db_id – database row id of domain

Usage:

mydomain = MiddlewareDomain(name='master', provider=haw_provider)

mydomains = MiddlewareDomain.domains()
domain(*args, **kwargs)
domain_in_db = None
domain_in_mgmt = None
domain_in_rest = None
classmethod domains(provider=None, strict=True)[source]
classmethod domains_in_db(name=None, feed=None, provider=None, strict=True)[source]
classmethod domains_in_mgmt(provider=None)[source]
classmethod download(extension, provider=None)[source]
classmethod headers()[source]
is_running(*args, **kwargs)
is_running_in_db = None
is_running_in_mgmt = None
load_details(refresh=False)[source]
property_tuples = [('name', 'Name')]
taggable_type = 'MiddlewareDomain'
cfme.middleware.messaging module
class cfme.middleware.messaging.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.middleware.messaging.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.messaging.MiddlewareMessaging(name, server, provider=None, appliance=None, **kwargs)[source]

Bases: cfme.middleware.provider.MiddlewareBase, utils.appliance.Navigatable, cfme.common.Taggable, cfme.common.UtilizationMixin

MiddlewareMessaging class provides details on messaging page. Class methods available to get existing messagings list

Parameters:
  • name – Name of the messaging
  • provider – Provider object (HawkularProvider)
  • nativeid – Native id (internal id) of messaging
  • server – Server object of the messaging (MiddlewareServer)
  • properties – Messaging providers
  • db_id – database row id of messaging

Usage:

mymessaging = MiddlewareMessaging(name='JMS Queue [hawkular/metrics/counters/new]',
                        server=ser_instance,
                        provider=haw_provider,
                        properties='ds-properties')

messagings = MiddlewareMessaging.messagings() [or]
messagings = MiddlewareMessaging.messagings(provider=haw_provider) [or]
messagings = MiddlewareMessaging.messagings(provider=haw_provider,server=ser_instance)
classmethod download(extension, provider=None, server=None)[source]
classmethod headers()[source]
load_details(refresh=False)[source]
messaging(*args, **kwargs)
messaging_in_db = None
messaging_in_mgmt = None
messaging_in_rest = None
classmethod messagings(provider=None, server=None)[source]
classmethod messagings_in_db(server=None, provider=None, strict=True)[source]
classmethod messagings_in_mgmt(provider=None, server=None)[source]
property_tuples = [('name', 'Name'), ('nativeid', 'Nativeid'), ('messaging_type', 'Messaging type')]
taggable_type = 'MiddlewareMessaging'
cfme.middleware.server module
class cfme.middleware.server.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.middleware.server.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.server.MiddlewareServer(name, provider=None, appliance=None, **kwargs)[source]

Bases: cfme.middleware.provider.MiddlewareBase, cfme.common.Taggable, cfme.middleware.provider.Container, utils.appliance.Navigatable, cfme.common.UtilizationMixin

MiddlewareServer class provides actions and details on Server page. Class method available to get existing servers list

Parameters:
  • name – name of the server
  • hostname – Host name of the server
  • provider – Provider object (HawkularProvider)
  • product – Product type of the server
  • feed – feed of the server
  • db_id – database row id of server

Usage:

myserver = MiddlewareServer(name='Foo.war', provider=haw_provider)
myserver.reload_server()

myservers = MiddlewareServer.servers()
deployment_message = 'Deployment "{}" has been initiated on this server.'
classmethod download(extension, provider=None, server_group=None)[source]
classmethod headers()[source]
is_immutable()[source]
is_reload_required(*args, **kwargs)
is_running(*args, **kwargs)
is_starting(*args, **kwargs)
is_stopped(*args, **kwargs)
is_stopping(*args, **kwargs)
is_suspended(*args, **kwargs)
kill_server()[source]
load_details(refresh=False)[source]
property_tuples = [('name', 'Name'), ('feed', 'Feed'), ('bound_address', 'Bind Address')]
reload_server()[source]
restart_server()[source]
resume_server()[source]
server(*args, **kwargs)
server_group(*args, **kwargs)
server_in_db = None
server_in_mgmt = None
server_in_rest = None
classmethod servers(provider=None, server_group=None, strict=True)[source]
classmethod servers_in_db(name=None, feed=None, provider=None, product=None, server_group=None, strict=True)[source]
classmethod servers_in_mgmt(provider=None, server_group=None)[source]
shutdown_server(timeout=10, cancel=False)[source]
start_server()[source]
stop_server()[source]
suspend_server(timeout=10, cancel=False)[source]
taggable_type = 'MiddlewareServer'
class cfme.middleware.server.ServerDatasources(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.server.ServerDeployments(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.server.ServerGroup(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.server.ServerMessagings(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.middleware.server_group module
class cfme.middleware.server_group.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite()[source]
step()[source]
class cfme.middleware.server_group.MiddlewareServerGroup(name, domain, appliance=None, **kwargs)[source]

Bases: cfme.middleware.provider.MiddlewareBase, cfme.common.Taggable, cfme.middleware.provider.Container, utils.appliance.Navigatable

MiddlewareServerGroup class provides actions and details on Server Group page. Class method available to get existing server groups list

Parameters:
  • name – name of the server group
  • domain – Domain (MiddlewareDomain) object to which belongs server group
  • profile – Profile of the server group
  • feed – feed of the server group
  • db_id – database row id of server group

Usage:

myservergroup = MiddlewareServerGroup(name='main-server-group', domain=middleware_domain)

myservergroups = MiddlewareServerGroup.server_groups()
deployment_message = 'Deployment "{}" has been initiated on this group.'
classmethod download(extension, domain)[source]
classmethod headers(domain)[source]
is_immutable()[source]
load_details(refresh=False)[source]
property_tuples = [('name', 'Name'), ('profile', 'Profile')]
reload_server_group()[source]
restart_server_group()[source]
resume_server_group()[source]
server_group(*args, **kwargs)
server_group_in_db = None
server_group_in_mgmt = None
server_group_in_rest = None
classmethod server_groups(domain, strict=True)[source]
classmethod server_groups_in_db(domain, name=None, strict=True)[source]
classmethod server_groups_in_mgmt(domain)[source]
start_server_group()[source]
stop_server_group(timeout=10, cancel=False)[source]
suspend_server_group(timeout=10, cancel=False)[source]
taggable_type = 'MiddlewareServerGroup'
class cfme.middleware.server_group.ServerGroupServers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.middleware.topology module
class cfme.middleware.topology.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.middleware.topology.MiddlewareTopology[source]

Bases: cfme.common.TopologyMixin

classmethod load_topology_page()[source]
Module contents
cfme.networks package
Subpackages
cfme.networks.provider package
Module contents
class cfme.networks.provider.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NetworkProviderView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NetworkProviderDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.NetworkProvider(name, provider=None, collection=None, appliance=None)[source]

Bases: cfme.common.provider.BaseProvider

Class representing network provider in sdn Note: Network provider can be added to cfme database

only automaticaly with cloud provider
STATS_TO_MATCH = []
balancers
category = 'networks'
db_types = ['NetworksManager']
delete(cancel=True)[source]

Deletes a network provider from CFME

detail_page_suffix = 'provider_detail'
edit_page_suffix = ''
exists
in_version = ('5.8', Version('master'))
networks
page_name = 'networks'
ports
property_tuples = []
provider_types = {}
quad_name = None
refresh_provider_relationships(cancel=True)[source]

Refresh relationships of network provider

refresh_text = 'Refresh items and relationships'
routers
security_groups
string_name = 'Networks'
subnets
valid_credentials_state

Checks whether credentials are valid

class cfme.networks.provider.NetworkProviderCollection(appliance=None)[source]

Bases: utils.appliance.Navigatable

Collection object for NetworkProvider object Note: Network providers object are not implemented in mgmt

all()[source]
instantiate(name)[source]
class cfme.networks.provider.OpenCloudNetworks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of OneProviderCloudNetworkView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.OpenCloudSubnets(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of OneProviderSubnetView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.OpenFloatingIPs(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.OpenNetworkBalancers(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of OneProviderBalancerView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.OpenNetworkPorts(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of OneProviderNetworkPortView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.OpenNetworkRouters(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of OneProviderNetworkRouterView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.OpenSecurityGroups(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of OneProviderSecurityGroupView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.provider.OpenTopologyFromDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
Submodules
cfme.networks.balancer module
class cfme.networks.balancer.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of BalancerView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.balancer.Balancer(name, provider=None, collection=None, appliance=None)[source]

Bases: cfme.common.WidgetasticTaggable, utils.appliance.Navigatable

Class representing balancers in sdn

category = 'networks'
db_types = ['NetworkBalancer']
detail_page_suffix = 'network_balancer_detail'
health_checks

Returns health check state

in_version = ('5.8', Version('master'))
listeners

Returns listeners of balancer

network_provider

Returns network provider

page_name = 'network_balancer'
quad_name = None
refresh_text = 'Refresh items and relationships'
string_name = 'NetworkBalancer'
class cfme.networks.balancer.BalancerCollection(appliance=None, parent_provider=None)[source]

Bases: utils.appliance.Navigatable

Collection object for Balancer object

all()[source]
instantiate(name)[source]
class cfme.networks.balancer.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of BalancerDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.balancer.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.networks.cloud_network module
class cfme.networks.cloud_network.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudNetworkView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.cloud_network.CloudNetwork(name, provider=None, collection=None, appliance=None)[source]

Bases: cfme.common.WidgetasticTaggable, utils.appliance.Navigatable

Class representing cloud networks in cfme database

category = 'networks'
db_types = ['CloudNetwork']
in_version = ('5.8', Version('master'))
network_provider

Returns network provider

network_type

Return type of network

page_name = 'cloud_network'
parent_provider

Return object of parent cloud provider

quad_name = None
string_name = 'CloudNetwork'
class cfme.networks.cloud_network.CloudNetworkCollection(appliance=None, parent_provider=None)[source]

Bases: utils.appliance.Navigatable

Collection object for Cloud Network object

all()[source]
instantiate(name)[source]
class cfme.networks.cloud_network.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CloudNetworkDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.cloud_network.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.networks.network_port module
class cfme.networks.network_port.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NetworkPortView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.network_port.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NetworkPortDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.network_port.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.network_port.NetworkPort(name, provider=None, collection=None, appliance=None)[source]

Bases: cfme.common.WidgetasticTaggable, utils.appliance.Navigatable

Class representing network ports in sdn

category = 'networks'
db_types = ['CloudNetworkPort']
fixed_ips

Returns fixed ips (string) of the port

floating_ips

Returns floating ips (string) of the port

in_version = ('5.8', Version('master'))
mac_address

Returns mac adress (string) of the port

network_provider

Returns network provider

network_type
page_name = 'network_port'
quad_name = None
string_name = 'NetworkPort'
class cfme.networks.network_port.NetworkPortCollection(appliance=None, parent_provider=None)[source]

Bases: utils.appliance.Navigatable

Collection object for NetworkPort object Note: Network providers object are not implemented in mgmt

all()[source]
instantiate(name)[source]
cfme.networks.network_router module
class cfme.networks.network_router.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NetworkRouterView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.network_router.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of NetworkRouterDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.network_router.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.network_router.NetworkRouter(name, provider=None, collection=None, appliance=None)[source]

Bases: cfme.common.WidgetasticTaggable, utils.appliance.Navigatable

Class representing network ports in sdn

category = 'networks'
db_types = ['NetworkRouter']
in_version = ('5.8', Version('master'))
network_provider

Returns network provider

page_name = 'NetworkRouter'
quad_name = None
string_name = 'NetworkRouter'
class cfme.networks.network_router.NetworkRouterCollection(appliance=None, parent_provider=None)[source]

Bases: utils.appliance.Navigatable

Collection object for NetworkRouter object Note: Network providers object are not implemented in mgmt

all()[source]
instantiate(name)[source]
cfme.networks.security_group module
class cfme.networks.security_group.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SecurityGroupView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.security_group.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SecurityGroupDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.security_group.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.security_group.SecurityGroup(name, provider=None, collection=None, appliance=None)[source]

Bases: cfme.common.WidgetasticTaggable, utils.appliance.Navigatable

Class representing security group in sdn

category = 'networks'
db_types = ['SecurityGroup']
in_version = ('5.8', Version('master'))
network_provider

Returns network provider

page_name = 'security_group'
quad_name = None
string_name = 'SecurityGroup'
class cfme.networks.security_group.SecurityGroupCollection(appliance=None, parent_provider=None)[source]

Bases: utils.appliance.Navigatable

Collection object for SecurityGroup object Note: Network providers object are not implemented in mgmt

all()[source]
instantiate(name)[source]
cfme.networks.subnet module
class cfme.networks.subnet.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SubnetView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.subnet.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SubnetDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.subnet.OpenCloudNetworks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SubnetDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.networks.subnet.Subnet(name, provider=None, collection=None, appliance=None)[source]

Bases: cfme.common.WidgetasticTaggable, utils.appliance.Navigatable

Class representing subnets in sdn

category = 'networks'
db_types = ['NetworkSubnet']
in_version = ('5.8', Version('master'))
network_provider

Returns network provider

page_name = 'network_subnet'
parent_provider

Return object of parent cloud provider

quad_name = None
string_name = 'NetworkSubnet'
zone
class cfme.networks.subnet.SubnetCollection(appliance=None, parent_provider=None)[source]

Bases: utils.appliance.Navigatable

Collection object for Subnet object Note: Network providers object are not implemented in mgmt

all()[source]
instantiate(name)[source]
cfme.networks.views module
class cfme.networks.views.BalancerDetailsSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar of balancer details

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.BalancerDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: cfme.networks.views.BalancerToolBar

Represents details toolbar of balancer summary

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.BalancerDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents detail view of network provider

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.BalancerEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents central view where all QuadIcons, etc are displayed

class cfme.networks.views.BalancerSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar, usually contains navigation, filters, etc

class cfme.networks.views.BalancerToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents balancers toolbar and its controls

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.BalancerView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All NetworkProviders page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.CloudNetworkDetailsSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar of network providers details

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.CloudNetworkDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider details toolbar

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.CloudNetworkDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents detail view of cloud network

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.CloudNetworkEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents central view where all QuadIcons, etc are displayed

class cfme.networks.views.CloudNetworkSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar, usually contains navigation, filters, etc

class cfme.networks.views.CloudNetworkToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents cloud networks toolbar and its controls

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.CloudNetworkView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All Cloud network page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkPortDetailsSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar of network providers details

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkPortDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents toolbar of summary of port

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkPortDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents detail view of network provider

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkPortEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents central view where all QuadIcons, etc are displayed

class cfme.networks.views.NetworkPortSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar, usually contains navigation, filters, etc

class cfme.networks.views.NetworkPortToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider toolbar and its controls

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkPortView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All NetworkPorts page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkProviderDetailsSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar of network providers details

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkProviderDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: cfme.networks.views.NetworkProviderToolBar

Represents provider details toolbar

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkProviderDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents detail view of network provider

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkProviderEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents central view where all QuadIcons, etc are displayed

class cfme.networks.views.NetworkProviderSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar, usually contains navigation, filters, etc

class cfme.networks.views.NetworkProviderToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider toolbar and its controls

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkProviderView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All NetworkProviders page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkRouterDetailsSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar of network providers details

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkRouterDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider toolbar and its controls

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkRouterDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents detail view of network provider

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkRouterEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents central view where all QuadIcons, etc are displayed

class cfme.networks.views.NetworkRouterSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar, usually contains navigation, filters, etc

class cfme.networks.views.NetworkRouterToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider toolbar and its controls

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.NetworkRouterView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All NetworkRouters page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.OneProviderBalancerView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All Subnets page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.OneProviderCloudNetworkView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All Subnets page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.OneProviderComponentsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

back

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.OneProviderNetworkPortView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All Subnets page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.OneProviderNetworkRouterView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All Subnets page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.OneProviderSecurityGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All Subnets page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.OneProviderSubnetView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All Subnets page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SecurityGroupDetailsSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar of network providers details

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SecurityGroupDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider details toolbar

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SecurityGroupDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents detail view of network provider

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SecurityGroupEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents central view where all QuadIcons, etc are displayed

class cfme.networks.views.SecurityGroupSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar, usually contains navigation, filters, etc

class cfme.networks.views.SecurityGroupToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider toolbar and its controls

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SecurityGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All SecurityGroups page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SubnetDetailsSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar of network providers details

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SubnetDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider details toolbar

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SubnetDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents detail view of network provider

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SubnetEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

Represents central view where all QuadIcons, etc are displayed

class cfme.networks.views.SubnetSideBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents left side bar, usually contains navigation, filters, etc

class cfme.networks.views.SubnetToolBar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

Represents provider toolbar and its controls

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.networks.views.SubnetView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Represents whole All Subnets page

entities
flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents
cfme.optimize package
Submodules
cfme.optimize.bottlenecks module
class cfme.optimize.bottlenecks.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of BottlenecksTabsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]

Set values to default

class cfme.optimize.bottlenecks.Bottlenecks(appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

class cfme.optimize.bottlenecks.BottlenecksTabsView(parent, logger=None, **kwargs)[source]

Bases: cfme.optimize.BottlenecksView

is_displayed
report

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

summary

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.optimize.utilization module
class cfme.optimize.utilization.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.optimize.utilization.Utilization(appliance=None)[source]

Bases: utils.appliance.Navigatable

Module contents
class cfme.optimize.Bottlenecks(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of BottlenecksView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.optimize.BottlenecksView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

bottlenecks

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_explorer()[source]
cfme.rest package
Submodules
cfme.rest.gen_data module
cfme.rest.gen_data.a_provider(request)[source]
cfme.rest.gen_data.arbitration_profiles(request, rest_api, a_provider, num=2)[source]
cfme.rest.gen_data.arbitration_rules(request, rest_api, num=2)[source]
cfme.rest.gen_data.arbitration_settings(request, rest_api, num=2)[source]
cfme.rest.gen_data.automation_requests_data(vm, requests_collection=False, approve=True, num=4)[source]
cfme.rest.gen_data.blueprints(request, rest_api, num=2)[source]
cfme.rest.gen_data.categories(request, rest_api, num=1)[source]
cfme.rest.gen_data.conditions(request, rest_api, num=2)[source]
cfme.rest.gen_data.copy_role(rest_api, orig_name, new_name=None)[source]
cfme.rest.gen_data.dialog()[source]
cfme.rest.gen_data.groups(request, rest_api, role, tenant, num=1)[source]
cfme.rest.gen_data.mark_vm_as_template(rest_api, provider, vm_name)[source]

Function marks vm as template via mgmt and returns template Entity .. rubric:: Usage:

mark_vm_as_template(rest_api, provider, vm_name)
cfme.rest.gen_data.orchestration_templates(request, rest_api, num=2)[source]
cfme.rest.gen_data.policies(request, rest_api, num=2)[source]
cfme.rest.gen_data.rates(request, rest_api, num=3)[source]
cfme.rest.gen_data.roles(request, rest_api, num=1)[source]
cfme.rest.gen_data.service_catalog_obj(request, rest_api)[source]

Return service catalog object.

cfme.rest.gen_data.service_catalogs(request, rest_api, num=5)[source]

Create service catalogs using REST API.

cfme.rest.gen_data.service_data(request, rest_api, a_provider, service_dialog=None, service_catalog=None)[source]
cfme.rest.gen_data.service_templates(request, rest_api, service_dialog=None, service_catalog=None, num=4)[source]
cfme.rest.gen_data.service_templates_rest(request, rest_api, service_dialog=None, service_catalog=None, num=4)[source]
cfme.rest.gen_data.service_templates_ui(request, rest_api, service_dialog=None, service_catalog=None, a_provider=None, num=4)[source]
cfme.rest.gen_data.services(request, rest_api, a_provider, service_dialog=None, service_catalog=None)[source]

The attempt to add the service entities via web

cfme.rest.gen_data.tags(request, rest_api, categories)[source]
cfme.rest.gen_data.tenants(request, rest_api, num=1)[source]
cfme.rest.gen_data.users(request, rest_api, num=1)[source]
cfme.rest.gen_data.vm(request, a_provider, rest_api)[source]
Module contents
cfme.scripting package
Subpackages
cfme.scripting.tests package
Submodules
cfme.scripting.tests.test_quickstart module
cfme.scripting.tests.test_quickstart.check_docker()[source]
cfme.scripting.tests.test_quickstart.root_volume()[source]
cfme.scripting.tests.test_quickstart.test_quickstart_run(image, python, root_volume, yamls_volume)[source]
cfme.scripting.tests.test_quickstart.yamls_volume()[source]
Module contents
Submodules
cfme.scripting.appliance module

Script to encrypt config files.

Usage:

scripts/encrypt_conf.py confname1 confname2 ... confnameN
scripts/encrypt_conf.py credentials
cfme.scripting.appliance.fn(method, *args, **kwargs)[source]

Helper to access the right properties

cfme.scripting.appliance.get_appliance(appliance_ip)[source]

Checks an appliance is not None and if so, loads the appropriate things

cfme.scripting.conf module

Script to encrypt config files.

Usage:

scripts/encrypt_conf.py confname1 confname2 ... confnameN
scripts/encrypt_conf.py credentials
cfme.scripting.disable_bytecode module
cfme.scripting.disable_bytecode.ensure_file_contains(target, content)[source]
cfme.scripting.ipyshell module
cfme.scripting.miq module
cfme.scripting.quickstart module
cfme.scripting.quickstart.call_or_exit(command, shell=False, **kw)[source]
cfme.scripting.quickstart.command_text(command, shell)[source]
cfme.scripting.quickstart.disable_bytecode(venv_path)[source]
cfme.scripting.quickstart.ensure_pycurl_works(venv_path)[source]
cfme.scripting.quickstart.hash_file(path)[source]
cfme.scripting.quickstart.install_requirements(venv_path, quiet=False)[source]
cfme.scripting.quickstart.install_system_packages()[source]
cfme.scripting.quickstart.main(args)[source]
cfme.scripting.quickstart.pip_json_list(venv)[source]
cfme.scripting.quickstart.pip_version_list_to_map(version_list)[source]
cfme.scripting.quickstart.print_packages_diff(old, new)[source]
cfme.scripting.quickstart.print_version_diff(old, new)[source]
cfme.scripting.quickstart.self_install(venv_path)[source]
cfme.scripting.quickstart.setup_virtualenv(target, use_site)[source]
cfme.scripting.quickstart.venv_call(venv_path, command, *args, **kwargs)[source]
cfme.scripting.quickstart.version_changes(old, new)[source]
cfme.scripting.runtest module
cfme.scripting.runtest.main()[source]
cfme.scripting.setup_ansible module
cfme.scripting.setup_ansible.get_ansible_password(app)[source]
cfme.scripting.setup_ansible.install_packages(app)[source]
cfme.scripting.setup_ansible.open_port(app)[source]
cfme.scripting.setup_ansible.run_command(app, command)[source]
cfme.scripting.setup_ansible.setup_ansible(app, license_path)[source]
cfme.scripting.setup_ansible.setup_repos(app)[source]
cfme.scripting.setup_ansible.stop_embedded_ansible(app)[source]
cfme.scripting.setup_ansible.upload_license(app, license_path)[source]
cfme.scripting.sprout module

Script to checkout a sprout appliance

Usage:

sprout.py checkout
Module contents
cfme.services package
Subpackages
cfme.services.catalogs package
Submodules
cfme.services.catalogs.ansible_catalog_item module
class cfme.services.catalogs.ansible_catalog_item.ActionsCell(parent, tab, logger=None)[source]

Bases: widgetastic.widget.View

delete

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

edit

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.ansible_catalog_item.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddAnsibleCatalogItemView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.ansible_catalog_item.AddAnsibleCatalogItemView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ansible_catalog_item.AnsibleCatalogItemForm

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.ansible_catalog_item.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AllCatalogItemView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.ansible_catalog_item.AnsibleCatalogItemForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

catalog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display_in_catalog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

provisioning

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

retirement

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.ansible_catalog_item.AnsibleExtraVariables(parent, tab, logger=None)[source]

Bases: widgetastic.widget.View

Represents extra variables part of ansible service catalog edit form.

Parameters:tab (str) – tab name where this view is located. Can be “provisioning” or “retirement”.
add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

all_vars
default_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

fill(*args, **kwargs)[source]
Parameters:values (list) – [] to remove all vars or [(“var”, “value”), ...] to fill the view.
read(*args, **kwargs)[source]
variable

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

variables_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.ansible_catalog_item.AnsiblePlaybookCatalogItem(name, description, provisioning, display_in_catalog=None, catalog=None, retirement=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable, cfme.common.WidgetasticTaggable

Represents Ansible Playbook catalog item.

Example

from cfme.services.catalogs.ansible_catalog_item import AnsiblePlaybookCatalogItem
catalog_item = AnsiblePlaybookCatalogItem(
    "some_catalog_name",
    "some_description",
    provisioning={
        "repository": "Some repository",
        "playbook": "some_playbook.yml",
        "machine_credential": "CFME Default Credential",
        "create_new": True,
        "provisioning_dialog_name": "some_dialog",
        "extra_vars": [("some_var", "some_value")]
    }
)
catalog_item.create()
catalog_item.delete()
Parameters:
  • name (str) – catalog item name
  • description (str) – catalog item description
  • provisioning (dict) – provisioning data
  • catalog (py:class:cfme.services.catalogs.catalog.Catalog) – catalog object
  • display_in_catalog (bool) – whether this playbook displayed in catalog
  • retirement (dict) – retirement data
create()[source]
delete(cancel=False)[source]
exists
update(updates)[source]
class cfme.services.catalogs.ansible_catalog_item.BootstrapSelect(parent, id=None, name=None, locator=None, can_hide_on_select=False, logger=None)[source]

Bases: widgetastic_patternfly.BootstrapSelect

BootstrapSelect widget for Ansible Playbook Catalog Item form.

BootstrapSelect widgets don’t have data-id attribute in this form, so we have to override ROOT locator.

ROOT
class cfme.services.catalogs.ansible_catalog_item.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsAnsibleCatalogItemView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.ansible_catalog_item.DetailsAnsibleCatalogItemView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

Has to be in view standards, changed for WidgetasticTaggable.get_tags()

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.ansible_catalog_item.DetailsEntitiesAnsibleCatalogItemView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

basic_information

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

custom_image

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

provisioning

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

retirement

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

upload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.ansible_catalog_item.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditAnsibleCatalogItemView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.ansible_catalog_item.EditAnsibleCatalogItemView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ansible_catalog_item.AnsibleCatalogItemForm

is_displayed
reset

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.ansible_catalog_item.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TagPageView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.ansible_catalog_item.PickItemType(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SelectCatalogItemTypeView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.ansible_catalog_item.SelectCatalogItemTypeView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

catalog_item_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.services.catalogs.catalog module
class cfme.services.catalogs.catalog.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddCatalogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog.AddCatalogView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog.CatalogForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.catalog.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CatalogsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog.Catalog(name=None, description=None, items=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

create()[source]
delete()[source]
exists
update(updates)[source]
class cfme.services.catalogs.catalog.CatalogForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

assign_catalog_items

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog.CatalogsMultiBoxSelect(parent, move_into=None, move_from=None, available_items=None, chosen_items=None, logger=None)[source]

Bases: widgetastic_manageiq.MultiBoxSelect

move_from_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

move_into_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog.CatalogsView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsCatalogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog.DetailsCatalogView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditCatalogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog.EditCatalogView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog.CatalogForm

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.services.catalogs.catalog_item module
class cfme.services.catalogs.catalog_item.Add(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddCatalogItemView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.AddButton(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddButtonView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.AddButtonGroup(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddButtonGroupView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.AddButtonGroupView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog_item.ButtonGroupForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.catalog_item.AddButtonView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog_item.ButtonForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.catalog_item.AddCatalogBundleView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog_item.CatalogBundleFormView

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

apply_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.catalog_item.AddCatalogItemView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog_item.CatalogForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

apply_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
template_table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AllCatalogItemView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.AllCatalogItemView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.BasicInfoForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

display

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

field_entry_point

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

retirement_entry_point

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_catalog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_config_template

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_dialog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_orch_template

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_resource

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tree

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
class cfme.services.catalogs.catalog_item.BundleAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddCatalogBundleView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.BundleAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AllCatalogItemView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.BundleDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsCatalogItemView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.BundleEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditCatalogBundleView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.ButtonForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

btn_hvr_text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

btn_image

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

btn_text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

request

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_dialog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

system_process

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.ButtonGroupForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

btn_group_hvr_text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

btn_group_text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

btn_image

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.CatalogBundle(name=None, description=None, display_in=None, catalog=None, dialog=None, catalog_items=None, appliance=None)[source]

Bases: cfme.services.catalogs.catalog_item.CatalogItem, utils.appliance.Navigatable

create()[source]
update(updates)[source]
class cfme.services.catalogs.catalog_item.CatalogBundleFormView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

basic_info

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

resources

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.CatalogForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog_item.BasicInfoForm

before_filling()[source]
is_displayed
select_item_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.CatalogItem(name=None, description=None, item_type=None, vm_name=None, display_in=False, catalog=None, dialog=None, catalog_name=None, orch_template=None, provider_type=None, provider=None, config_template=None, prov_data=None, domain='ManageIQ (Locked)', appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable, cfme.common.WidgetasticTaggable

add_button()[source]
add_button_group()[source]
create()[source]
delete()[source]
exists
update(updates)[source]
class cfme.services.catalogs.catalog_item.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsCatalogItemView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.DetailsCatalogItemView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.Edit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditCatalogItemView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.catalog_item.EditCatalogBundleView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog_item.CatalogBundleFormView

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.EditCatalogItemView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.catalog_item.BasicInfoForm

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.catalog_item.EditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TagPageView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
cfme.services.catalogs.orchestration_template module
class cfme.services.catalogs.orchestration_template.AddDialog(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddDialogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.orchestration_template.AddDialogView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.orchestration_template.DialogForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.orchestration_template.AddTemplate(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AddTemplateView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.orchestration_template.AddTemplateView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.orchestration_template.TemplateForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.orchestration_template.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of OrchestrationTemplatesView

am_i_here(*args, **kwargs)[source]
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.orchestration_template.CopyTemplate(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of CopyTemplateView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.orchestration_template.CopyTemplateForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

content

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

draft

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.orchestration_template.CopyTemplateView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.orchestration_template.CopyTemplateForm

add_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.catalogs.orchestration_template.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsTemplateView

am_i_here(*args, **kwargs)[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.orchestration_template.DetailsTemplateView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed

Removing last ‘s’ character from template_type. For ex. ‘CloudFormation Templates’ -> ‘CloudFormation Template’

class cfme.services.catalogs.orchestration_template.DialogForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.orchestration_template.EditTemplate(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditTemplateView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.orchestration_template.EditTemplateView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.orchestration_template.TemplateForm

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.orchestration_template.OrchestrationTemplate(template_type=None, template_name=None, description=None, draft=None, content=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

copy_template(template_name, content, draft=None, description=None)[source]
create(content)[source]
create_service_dialog_from_template(dialog_name, template_name)[source]
delete()[source]
delete_all_templates()[source]
update(updates)[source]
class cfme.services.catalogs.orchestration_template.OrchestrationTemplatesView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.orchestration_template.TemplateForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.orchestration_template.CopyTemplateForm

template_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.orchestration_template.TemplateType(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of TemplateTypeView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.orchestration_template.TemplateTypeView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
templates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.services.catalogs.service_catalogs module
class cfme.services.catalogs.service_catalogs.DetailsServiceCatalogView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
order_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.service_catalogs.OrderForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

db_root_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

db_user

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

default_select_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flavor

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hosts

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

image

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

key

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

key_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

machine_credential

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

mode

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

os_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

private_network

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

resource_group

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_instance_type

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ssh_location

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

stack_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

stack_timeout

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

timeout

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

user_image

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_password

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_size

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vm_user

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.service_catalogs.OrderServiceCatalogView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.service_catalogs.OrderForm

is_displayed
submit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.service_catalogs.ServiceCatalogDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of DetailsServiceCatalogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.service_catalogs.ServiceCatalogOrder(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of OrderServiceCatalogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.service_catalogs.ServiceCatalogs(catalog=None, name=None, stack_data=None, dialog_values=None, ansible_dialog_values=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

order()[source]
class cfme.services.catalogs.service_catalogs.ServiceCatalogsAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServiceCatalogsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.service_catalogs.ServiceCatalogsDefault(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServiceCatalogsDefaultView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.service_catalogs.ServiceCatalogsDefaultView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.catalogs.service_catalogs.ServiceCatalogsView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.catalogs.ServicesCatalogView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents
class cfme.services.catalogs.ServicesCatalog(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServicesCatalogView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.catalogs.ServicesCatalogView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

catalog_items

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

catalogs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_explorer()[source]
is_displayed
orchestration_templates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

service_catalogs

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Submodules
cfme.services.myservice module
class cfme.services.myservice.EditMyServiceView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.ServiceEditForm

cancel_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.EditTagsForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.MyServicesView

select_tag

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_value

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.EditTagsView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.EditTagsForm

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.MyService(name, description=None, vm_name=None, appliance=None)[source]

Bases: utils.update.Updateable, utils.appliance.Navigatable

check_vm_add(add_vm_name)[source]
delete()[source]
download_file(extension)[source]
edit_tags(tag, value)[source]
exists
reconfigure_service()[source]
retire()[source]
retire_on_date(retirement_date)[source]
set_ownership(owner, group)[source]
update(updates)[source]
class cfme.services.myservice.MyServiceAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MyServicesView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.services.myservice.MyServiceDetailView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.MyServicesView

details

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
provisioning

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

retirement

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.MyServiceDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of MyServiceDetailView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.myservice.MyServiceEdit(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditMyServiceView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.myservice.MyServiceEditTags(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditTagsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.myservice.MyServiceReconfigure(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ReconfigureServiceView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.myservice.MyServiceSetOwnership(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SetOwnershipView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.myservice.MyServiceSetRetirement(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ServiceRetirementView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.myservice.MyServicesView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download_choice

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

in_myservices()[source]
is_displayed
lifecycle_btn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

myservice

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy_btn

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.ReconfigureServiceView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.SetOwnershipForm

is_displayed
submit_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.ServiceEditForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.MyServicesView

description

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.ServiceRetirementForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.MyServicesView

retirement_date

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

retirement_warning

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.ServiceRetirementView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.ServiceRetirementForm

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.SetOwnershipForm(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.MyServicesView

select_group

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_owner

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.myservice.SetOwnershipView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.myservice.SetOwnershipForm

is_displayed
save_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.services.requests module
class cfme.services.requests.ApproveRequest(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RequestApprovalView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.requests.CopyRequest(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RequestCopyView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.requests.DenyRequest(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RequestDenialView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.requests.EditRequest(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RequestEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.requests.Request(description=None, cells=None, partial_check=False, appliance=None)[source]

Bases: utils.appliance.Navigatable

Class describes request row from Services - Requests page

REQUEST_FINISHED_STATES = set(['Migrated', 'Finished'])
approve_request(*args, **kwargs)
approve_request_ui = None
copy_request(values=None, cancel=False)[source]

Copies the request and edits if needed

deny_request(*args, **kwargs)
deny_request_ui = None
edit_request(values, cancel=False)[source]

Opens the request for editing and saves or cancels depending on success.

exists(*args, **kwargs)
exists_ui = None
get_request_id()[source]
get_request_row_from_ui()[source]

Opens CFME UI and return table_row object

is_finished(*args, **kwargs)
is_finished_ui = None
is_succeeded(*args, **kwargs)
is_succeeded_ui = None
remove_request(cancel=False)[source]

Opens the specified request and deletes it - removes from UI :param cancel: Whether to cancel the deletion.

request_state
rest
status
update(*args, **kwargs)
update_ui = None
wait_for_request(*args, **kwargs)
wait_for_request_ui = None
class cfme.services.requests.RequestAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RequestsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.services.requests.RequestApprovalView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.requests.RequestDetailsView

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reason

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

submit

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.requests.RequestBasicView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

in_requests
reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.requests.RequestCopyView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.requests.RequestProvisionView

is_displayed
class cfme.services.requests.RequestDenialView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.requests.RequestDetailsView

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
reason

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

submit

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.requests.RequestDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RequestDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.services.requests.RequestDetailsToolBar(parent, logger=None, **kwargs)[source]

Bases: cfme.services.requests.RequestsView

approve

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

copy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

delete

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

deny

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

edit

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.requests.RequestDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.requests.RequestsView

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

catalog

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

customize

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

details

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

environment

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

hardware

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
network

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

purpose

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

request

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

schedule

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.requests.RequestEditView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.requests.RequestProvisionView

is_displayed
class cfme.services.requests.RequestProvisionView(parent, logger=None, **kwargs)[source]

Bases: cfme.common.vm_views.ProvisionView

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.services.requests.RequestsView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.requests.RequestBasicView

find_request(cells, partial_check=False)[source]

Finds the request and returns the row element :param cells: Search data for the requests table. :param partial_check: If to use the __contains operator

Returns: row

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
paginator

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
table

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.services.workloads module

A model of Workloads page in CFME

class cfme.services.workloads.AllTemplates(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of WorkloadsTemplate

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.services.workloads.AllVMs(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of WorkloadsVM

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.services.workloads.TemplatesImages(appliance=None)[source]

Bases: utils.appliance.Navigatable

This is fake class mainly needed for navmazing navigation

class cfme.services.workloads.VmsInstances(appliance=None)[source]

Bases: utils.appliance.Navigatable

This is fake class mainly needed for navmazing navigation

class cfme.services.workloads.WorkloadsDefault(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of WorkloadsDefaultView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.services.workloads.WorkloadsDefaultView(parent, logger=None, **kwargs)[source]

Bases: cfme.services.workloads.WorkloadsView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.workloads.WorkloadsTemplate(parent, logger=None, **kwargs)[source]

Bases: cfme.services.workloads.WorkloadsView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.workloads.WorkloadsVM(parent, logger=None, **kwargs)[source]

Bases: cfme.services.workloads.WorkloadsView

is_displayed
title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.services.workloads.WorkloadsView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

in_workloads
search

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

templates

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

vms

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

Module contents
cfme.storage package
Submodules
cfme.storage.object_store module
class cfme.storage.object_store.All(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()[source]
step()[source]
class cfme.storage.object_store.Details(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

am_i_here()[source]
prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.storage.object_store.ObjectStore(name=None, appliance=None)[source]

Bases: cfme.common.Taggable, cfme.common.SummaryMixin, utils.appliance.Navigatable

Automate Model page of Cloud Object Stores

Parameters:name – Name of Object Store
add_tag(tag, **kwargs)[source]

Tags the system by given tag

untag(tag)[source]

Removes the selected tag off the system

cfme.storage.volume module
class cfme.storage.volume.NonJSVolumeEntity(parent, name, logger=None)[source]

Bases: widgetastic_manageiq.NonJSBaseEntity

list_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

quad_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tile_entity

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.Volume(name, provider, collection)[source]

Bases: utils.appliance.NavigatableMixin

delete(wait=True)[source]

Delete the Volume

exists
nav

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
wait_for_disappear(timeout=300)[source]
class cfme.storage.volume.VolumeAdd(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of VolumeAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.storage.volume.VolumeAddEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeAddForm(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

add

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cancel

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

size

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

tenant

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

volume_name

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeAddView(parent, logger=None, **kwargs)[source]

Bases: cfme.storage.volume.VolumeView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
class cfme.storage.volume.VolumeAll(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of VolumeAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.storage.volume.VolumeAllView(parent, logger=None, **kwargs)[source]

Bases: cfme.storage.volume.VolumeView

entities
is_displayed
toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeCollection(appliance)[source]

Bases: utils.appliance.NavigatableMixin

Collection object for the :py:class:’cfme.storage.volume.Volume’.

delete(*volumes)[source]

Delete one or more Volumes from list of Volumes

Parameters:or Multiple 'cfme.storage.volume.Volume' objects (One) –
instantiate(name, provider)[source]
class cfme.storage.volume.VolumeDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of VolumeDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)[source]
class cfme.storage.volume.VolumeDetailsAccordion(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeDetailsEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

breadcrumb

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

flash

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

properties

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

relationships

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

smart_management

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeDetailsToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeDetailsView(parent, logger=None, **kwargs)[source]

Bases: cfme.storage.volume.VolumeView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed
sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeEntities(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseEntitiesView

The entities on the main list of Volume Page

entity_class
cfme.storage.volume.VolumeEntity()[source]

Temporary wrapper for Volume Entity during transition to JS based Entity

class cfme.storage.volume.VolumeListEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseListEntity

class cfme.storage.volume.VolumeQuadIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseQuadIconEntity

class cfme.storage.volume.VolumeTileIconEntity(parent, logger=None, **kwargs)[source]

Bases: widgetastic_manageiq.BaseTileIconEntity

quad_icon

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeToolbar(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

view_selector

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.storage.volume.VolumeView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

Base class for header and nav check

in_volume
Module contents
cfme.test_framework package
Subpackages
cfme.test_framework.sprout package
Submodules
cfme.test_framework.sprout.client module
class cfme.test_framework.sprout.client.APIMethodCall(client, method_name)[source]

Bases: object

exception cfme.test_framework.sprout.client.AuthException[source]

Bases: cfme.test_framework.sprout.client.SproutException

class cfme.test_framework.sprout.client.SproutClient(protocol='http', host='localhost', port=8000, entry='appliances/api', auth=None)[source]

Bases: object

api_entry
call_method(name, *args, **kwargs)[source]
destroy_pool(pool_id)[source]
classmethod from_config(**kwargs)[source]
provision_appliances(count=1, preconfigured=False, version=None, stream=None, provider=None, lease_time=120, ram=None, cpu=None)[source]
exception cfme.test_framework.sprout.client.SproutException[source]

Bases: exceptions.Exception

cfme.test_framework.sprout.plugin module
class cfme.test_framework.sprout.plugin.NewHooks[source]

Bases: object

pytest_miq_node_shutdown(config, nodeinfo)[source]
class cfme.test_framework.sprout.plugin.ShutdownPlugin[source]

Bases: object

pytest_miq_node_shutdown(config, nodeinfo)[source]
class cfme.test_framework.sprout.plugin.SproutManager(client=NOTHING)[source]

Bases: object

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

check_fullfilled()[source]
clean_jenkins_job(jenkins_job)[source]
client = Attribute(name='client', default=Factory(factory=<bound method type.from_config of <class 'cfme.test_framework.sprout.client.SproutClient'>>, takes_self=False), validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
destroy_pool()[source]
lease_time = Attribute(name='lease_time', default=None, validator=None, repr=False, cmp=True, hash=None, init=False, convert=None, metadata=mappingproxy({}))
ping_pool()[source]
pool = Attribute(name='pool', default=None, validator=None, repr=True, cmp=True, hash=None, init=False, convert=None, metadata=mappingproxy({}))
request_appliances(provision_request)[source]
request_check()[source]
request_pool(provision_request)[source]
reset_timer(timeout=None)[source]
timer = Attribute(name='timer', default=None, validator=None, repr=False, cmp=True, hash=None, init=False, convert=None, metadata=mappingproxy({}))
class cfme.test_framework.sprout.plugin.SproutProvisioningRequest(group, count, version, provider, date, lease_time, desc, provision_timeout, cpu, ram)[source]

Bases: object

data holder for provisioning metadata

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

count = Attribute(name='count', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
cpu = Attribute(name='cpu', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
date = Attribute(name='date', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
desc = Attribute(name='desc', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
classmethod from_config(config)[source]
group = Attribute(name='group', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
lease_time = Attribute(name='lease_time', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
provider = Attribute(name='provider', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
provision_timeout = Attribute(name='provision_timeout', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
ram = Attribute(name='ram', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
version = Attribute(name='version', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
cfme.test_framework.sprout.plugin.dump_pool_info(log, pool_data)[source]
cfme.test_framework.sprout.plugin.pytest_addhooks(pluginmanager)[source]
cfme.test_framework.sprout.plugin.pytest_addoption(parser)[source]
cfme.test_framework.sprout.plugin.pytest_configure(config)[source]
Module contents
Submodules
cfme.test_framework.appliance_police module
exception cfme.test_framework.appliance_police.AppliancePoliceException(message, port)[source]

Bases: exceptions.Exception

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

message = Attribute(name='message', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
port = Attribute(name='port', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
cfme.test_framework.appliance_police.appliance_police()[source]
cfme.test_framework.config module

classes to manage the cfme test framework configuration

class cfme.test_framework.config.Configuration[source]

Bases: object

holds the current configuration

configure(config_dir, crypt_key_file=None)[source]

do the defered initial loading of the configuration

Parameters:
  • config_dir – path to the folder with configuration files
  • crypt_key_file – optional name of a file holding the key for encrypted configuration files
Raises:

AssertionError if called more than once

if the utils.conf api is removed, the loading can be transformed to eager loading

get_config(name)[source]

returns a yaycl config object

Parameters:name – name of the configuration object
class cfme.test_framework.config.DeprecatedConfigWrapper(configuration, warn=False)[source]

Bases: object

a wrapper that provides the old :code:utils.conf api

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

configuration = Attribute(name='configuration', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
runtime
cfme.test_framework.pytest_plugin module

cfme main plugin

this loads all of the elemental cfme plugins and prepares configuration

cfme.test_framework.pytest_plugin.pytest_addoption(parser)[source]
cfme.test_framework.pytest_plugin.pytest_collection_finish(session)[source]
cfme.test_framework.pytest_plugin.pytest_configure(config)[source]
Module contents
cfme.web_ui package
Submodules
cfme.web_ui.accordion module

A set of functions for dealing with accordions in the UI.

Usage:

Using Accordions is simply a case of either selecting it to return the element,
or using the built in click method. As shown below::

  acc = web_ui.accordion

  acc.click('Diagnostics')
  acc.is_active('Diagnostics')
cfme.web_ui.accordion.click(name)[source]

Clicks an accordion and returns it

Parameters:name – The name of the accordion.

Returns: A web element of the clicked accordion.

cfme.web_ui.accordion.is_active(name)[source]

Checks if an accordion is currently open

Note: Only works on traditional accordions.

Parameters:name – The name of the accordion.

Returns: True if the button is depressed, False if not.

cfme.web_ui.accordion.locate(name)[source]

Returns an accordion by name

Parameters:name – The name of the accordion.

Returns: A web element of the selected accordion.

cfme.web_ui.accordion.refresh(name)[source]

Closes and opens accordion

Parameters:name – The name of the accordion.

Returns: A web element of the clicked accordion.

cfme.web_ui.accordion.tree(name, *path)[source]

Get underlying Tree() object. And eventually click path.

If the accordion is not active, will be clicked. Attention! The object is ‘live’ so when it’s obscured, it won’t work!

Usage:

accordion.tree("Something").click_path("level 1", "level 2")
accordion.tree("Something", "level 1", "level 2")  # is the same
Parameters:*path – If specified, it will directly pass these parameters into click_path of Tree. Otherwise it returns the Tree object.
cfme.web_ui.cfme_exception module

Module handling the Rails exceptions from CFME

cfme.web_ui.cfme_exception.assert_no_cfme_exception()[source]

Raise an exception if CFME exception occured

Raises: cfme.exceptions.CFMEExceptionOccured

cfme.web_ui.cfme_exception.cfme_exception_text()[source]

Get the error message from the exception

cfme.web_ui.cfme_exception.is_cfme_exception()[source]

Check whether an exception is displayed on the page

cfme.web_ui.expression_editor module

The expression editor present in some locations of CFME.

class cfme.web_ui.expression_editor.Expression(show_func=<function <lambda>>)[source]

Bases: utils.pretty.Pretty

This class enables to embed the expression in a Form.

Parameters:show_func – Function to call to show the expression if there are more of them.
pretty_attrs = ['show_func']
cfme.web_ui.expression_editor.any_expression_present()[source]
cfme.web_ui.expression_editor.click_and()[source]
cfme.web_ui.expression_editor.click_commit()[source]
cfme.web_ui.expression_editor.click_discard()[source]
cfme.web_ui.expression_editor.click_not()[source]
cfme.web_ui.expression_editor.click_or()[source]
cfme.web_ui.expression_editor.click_redo()[source]
cfme.web_ui.expression_editor.click_remove()[source]
cfme.web_ui.expression_editor.click_undo()[source]
cfme.web_ui.expression_editor.delete_whole_expression()[source]
cfme.web_ui.expression_editor.fill_count(count=None, key=None, value=None)[source]

Fills the ‘Count of’ type of form.

If the value is unspecified and we are in the advanced search form (user input), the user_input checkbox will be checked if the value is None.

Parameters:
  • count – Name of the field to compare (Host.VMs, ...).
  • key – Operation to do (=, <, >=, ...).
  • value – Value to check against.

Returns: See cfme.web_ui.fill().

cfme.web_ui.expression_editor.fill_field(field=None, key=None, value=None)[source]

Fills the ‘Field’ type of form.

Parameters:
  • tag – Name of the field to compare (Host.VMs, ...).
  • key – Operation to do (=, <, >=, IS NULL, ...).
  • value – Value to check against.

Returns: See cfme.web_ui.fill().

cfme.web_ui.expression_editor.fill_find(field=None, skey=None, value=None, check=None, cfield=None, ckey=None, cvalue=None)[source]
cfme.web_ui.expression_editor.fill_registry(key=None, value=None, operation=None, contents=None)[source]

Fills the ‘Registry’ type of form.

cfme.web_ui.expression_editor.fill_tag(tag=None, value=None)[source]

Fills the ‘Tag’ type of form.

Parameters:
  • tag – Name of the field to compare.
  • value – Value to check against.

Returns: See cfme.web_ui.fill().

cfme.web_ui.expression_editor.get_expression_as_text()[source]

Returns whole expression as represented visually.

cfme.web_ui.expression_editor.get_func(name)[source]

Return callable from this module by its name.

Parameters:name – Name of the variable containing the callable.

Returns: Callable from this module

cfme.web_ui.expression_editor.is_editing()[source]
cfme.web_ui.expression_editor.no_expression_present()[source]
cfme.web_ui.expression_editor.run_commands(command_list, clear_expression=True)[source]

Run commands from the command list.

Command list syntax:
[
    "function1",                                                # no args
    "function2",                                                # dtto
    {"fill_fields": {"field1": "value", "field2": "value"}},    # Passes kwargs
    {"do_other_things": [1,2,3]}                                # Passes args
]
In YAML:
- function1
- function2
-
    fill_fields:
        field1: value
        field2: value
-
    do_other_things:
        - 1
        - 2
        - 3
Parameters:
  • command_list – list object of the commands
  • clear_expression – Whether to clear the expression before entering new one (default True)
cfme.web_ui.expression_editor.select_expression_by_text(text)[source]
cfme.web_ui.expression_editor.select_first_expression()[source]

There is always at least one (???), so no checking of bounds.

cfme.web_ui.expression_editor_widgetastic module

The expression editor present in some locations of CFME.

class cfme.web_ui.expression_editor_widgetastic.ExpressionEditor(parent, show_loc=None, logger=None)[source]

Bases: widgetastic.widget.View, utils.pretty.Pretty

This class enables to embed the expression in a Form.

Parameters:show_func – Function to call to show the expression if there are more of them.
AND

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
ATOM_ROOT = "./div[@id='exp_atom_editor_div']"
COMMIT

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
DISCARD

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
EXPRESSIONS_ROOT = './fieldset/div'
MAKE_BUTTON = "//span[not(contains(@style,'none'))]//img[@alt='{}']"
NOT

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
OR

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
REDO

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
REMOVE

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
ROOT = "//div[@id='exp_editor_div']"
SELECT_RELATIVE = "//img[@alt='Click to change to a relative Date/Time format']"
SELECT_SPECIFIC = "//img[@alt='Click to change to a specific Date/Time format']"
UNDO

A class that implements the version picking functionality.

Basic usage is a descriptor in which you place instances of VersionPick in a view. Whenever is this instance accessed from an instance, it automatically picks the correct variant based on product_version defined in the widgetastic.browser.Browser.

You can also use this separately using the pick() method.

Example:

class MyView(View):
    something_version_dependent = VersionPick({
        '1.0.0': Foo('bar'),
        '2.5.0': Bar('baz'),
    })

This sample will resolve the correct (Foo or Bar) kind of item and returns it.

Parameters:version_dict – Dictionary of version_introduced: item
any_expression_present()[source]
click_and()[source]
click_commit()[source]
click_discard()[source]
click_not()[source]
click_or()[source]
click_redo()[source]
click_remove()[source]
click_switch_to_relative()[source]
click_switch_to_specific()[source]
click_undo()[source]
count_form_view

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

date_relative_form_view

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

date_specific_form_view

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

delete_whole_expression()[source]
enable_editor()[source]
field_date_form

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

field_form_view

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

fill(*args, **kwargs)[source]
fill_count(count=None, key=None, value=None)[source]

Fills the ‘Count of’ type of form.

If the value is unspecified and we are in the advanced search form (user input), the user_input checkbox will be checked if the value is None.

Parameters:
  • count – Name of the field to compare (Host.VMs, ...).
  • key – Operation to do (=, <, >=, ...).
  • value – Value to check against.

Returns: See cfme.web_ui.fill().

fill_field(field=None, key=None, value=None)[source]

Fills the ‘Field’ type of form.

Parameters:
  • tag – Name of the field to compare (Host.VMs, ...).
  • key – Operation to do (=, <, >=, IS NULL, ...).
  • value – Value to check against.

Returns: See cfme.web_ui.fill().

fill_find(field=None, skey=None, value=None, check=None, cfield=None, ckey=None, cvalue=None)[source]
fill_registry(key=None, value=None, operation=None, contents=None)[source]

Fills the ‘Registry’ type of form.

fill_tag(tag=None, value=None)[source]

Fills the ‘Tag’ type of form.

Parameters:
  • tag – Name of the field to compare.
  • value – Value to check against.
find_form_view

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_editing()[source]
no_expression_present()[source]
pretty_attrs = ['show_loc']
read(*args, **kwargs)[source]

Returns whole expression as represented visually.

registry_form_view

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

select_expression_by_text(text)[source]
select_first_expression()[source]

There is always at least one (???), so no checking of bounds.

tag_form_view

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

cfme.web_ui.expression_editor_widgetastic.create_program(dsl_program, widget_object)[source]

Simple DSL to fill the expression editor.

Syntax:

DSL consists from statements. Statements are separated with newline or ;. Each statement is a single function call. Functions are called in this module. Function without parameters can be called like this: function or function()

If the function has some parameters, you have to choose whether they are kwargs or args. DSL has no string literals, so if you want to call a function with classic parameters: function(parameter one, parameter two, you cannot use comma) And with kwargs: function(username=John Doe, password=top secret) You cannot split the statement to multiple lines as the DSL is regexp-based.

Parameters:dsl_program – Source string with the program.

Returns: Callable, which fills the expression.

cfme.web_ui.expression_editor_widgetastic.create_program_from_list(command_list, widget_object)[source]

Create function which fills the expression from the command list.

Parameters:command_list – Command list for run_program()

Returns: Callable, which fills the expression.

cfme.web_ui.expression_editor_widgetastic.get_func(name, context)[source]

Return callable from this module by its name.

Parameters:name – Name of the variable containing the callable.

Returns: Callable from this module

cfme.web_ui.expression_editor_widgetastic.run_commands(command_list, clear_expression=True, context=None)[source]

Run commands from the command list.

Command list syntax:
[
    "function1",                                                # no args
    "function2",                                                # dtto
    {"fill_fields": {"field1": "value", "field2": "value"}},    # Passes kwargs
    {"do_other_things": [1,2,3]}                                # Passes args
]
In YAML:
- function1
- function2
-
    fill_fields:
        field1: value
        field2: value
-
    do_other_things:
        - 1
        - 2
        - 3
Parameters:
  • command_list – list object of the commands
  • clear_expression – Whether to clear the expression before entering new one
  • True) ((default) –
  • context – widget object
cfme.web_ui.flash module

Provides functions for the flash area.

var area:A cfme.web_ui.Region object representing the flash region.
class cfme.web_ui.flash.Message(message=None, level=None)[source]

Bases: utils.pretty.Pretty

A simple class to represent a flash error in CFME.

Parameters:
  • message – The message string.
  • level – The level of the message.
pretty_attrs = ['message', 'level']
cfme.web_ui.flash.assert_message_contain(*args, **kwargs)[source]

Asserts that a message contains a specific string

cfme.web_ui.flash.assert_message_match(*args, **kwargs)[source]

Asserts that a message matches a specific string.

cfme.web_ui.flash.assert_no_errors(*args, **kwargs)[source]

Asserts that there are no current Error messages. If no messages are passed in, they will be retrieved from the UI.

cfme.web_ui.flash.assert_success(*args, **kwargs)[source]

Asserts that there is 1 or more successful messages, no errors. If no messages are passed in, they will be retrieved from the UI.

cfme.web_ui.flash.assert_success_message(*args, **kwargs)[source]

Asserts that there are no errors and a (green) info message matches the given string.

cfme.web_ui.flash.dismiss()[source]

Dismiss the current flash message

cfme.web_ui.flash.get_all_messages()[source]

Returns a list of all flash messages, (including ones hidden behind the currently showing one, if any). All flash messages will be dismissed.

cfme.web_ui.flash.get_message_level_up(el)[source]
cfme.web_ui.flash.get_message_text_up(el)[source]
cfme.web_ui.flash.get_messages()[source]

Return a list of visible flash messages

cfme.web_ui.flash.is_error(message)[source]

Checks a given message to see if is an Error.’

Parameters:message – The message object.
cfme.web_ui.flash.message(el)[source]

Turns an element into a Message object.

Parameters:el – The element containing the flass message.

Returns: A Message object.

cfme.web_ui.flash.onexception_printall(f)[source]

If FlashMessageException happens, appends all the present flash messages in the error text

cfme.web_ui.flash.verify_rails_error(f)[source]
cfme.web_ui.flash.verpick_message(f)[source]

Wrapper that resolves eventual verpick dictionary passed to the function.

cfme.web_ui.form_buttons module

This module unifies working with CRUD form buttons.

Whenever you use Add, Save, Cancel, Reset button, use this module. You can use it also for the other buttons with same shape like those CRUD ones.

class cfme.web_ui.form_buttons.FormButton(alt, dimmed_alt=None, force_click=False, partial_alt=False, ng_click=None, classes=None)[source]

Bases: utils.pretty.Pretty

This class represents the buttons usually located in forms or CRUD.

Parameters:
  • alt – The text from alt field of the image.
  • dimmed_alt – In case the alt param is different in the dimmed variant of the button.
  • force_click – Click always, even if it is dimmed. (Causes an error if not visible)
  • partial_alt – Whether the alt matching should be only partial (in).
  • ng_click – To match the angular buttons, you can use this to specify the contents of ng-click attributeh.
class Button[source]

Holds pieces of the XPath to be assembled.

DIMMED = "(contains(@class, 'dimmed') or contains(@class, 'disabled') or contains(@class, 'btn-disabled'))"
IS_DISPLAYED = "not(ancestor::*[contains(@style, 'display:none') or contains(@style, 'display: none')])"
NOT_DIMMED = "not(contains(@class, 'dimmed') or contains(@class, 'disabled') or contains(@class, 'btn-disabled'))"
ON_CURRENT_TAB = "not(ancestor::div[contains(@class, 'tab-pane') and not(contains(@class, 'active'))])"
TAG_TYPES = '//a | //button | //img | //input'
TYPE_CONDITION = "(contains(@class, 'button') or contains(@class, 'btn') or contains(@src, 'button'))"
FormButton.PRIMARY = 'btn-primary'
FormButton.__call__(*args, **kwargs)[source]

For maintaining backward compatibility

FormButton.alt_expr(dimmed=False)[source]
FormButton.can_be_clicked

Whether the button is displayed, therefore clickable.

FormButton.is_dimmed
FormButton.locate()[source]
FormButton.pretty_attrs = ['_alt', '_dimmed_alt', '_force', '_partial', '_ng_click']
cfme.web_ui.form_buttons.change_stored_password()[source]
cfme.web_ui.history module

Module handling the history button.

var HISTORY_ITEMS:
 Locator that finds all the history items from dropdown
var SINGLE_HISTORY_BUTTON:
 Locator that finds the history button if it is without the dropdown.
cfme.web_ui.history.any_history_present()[source]

Returns if the single history button or the dropdown is present.

cfme.web_ui.history.dropdown_history_items()[source]

Returns a list of strings representing the items from dropdown. Empty if not present

cfme.web_ui.history.history_items()[source]

Returns a list of all history items on the page.

cfme.web_ui.history.history_items_present()[source]

Checks if the history items are present, returns bool

cfme.web_ui.history.select_history_item(text)[source]

Handles selecting the history item by text using the toolbar module.

cfme.web_ui.history.select_nth_history_item(n)[source]

Handles selecting the history items by the position. 0 is the latest (top one).

cfme.web_ui.history.single_button()[source]

Returns the textual contents of the single history button. If not present, None is returned.

cfme.web_ui.history.single_button_present()[source]

Checks if the single history button is present, returns bool

cfme.web_ui.jstimelines module

A Timelines object represents the Timelines widget in CFME using JS integration instead of relying on WebElements

param loc:A locator for the Timelines element, usually the div with id miq_timeline.
class cfme.web_ui.jstimelines.Event(element)[source]

Bases: cfme.web_ui.jstimelines.Object

An event object.

block_info()[source]

Attempts to return a dict with the information from the popup.

close_button = '//div[@class="timeline-event-bubble-title"]/../../div[contains(@style, \'close-button\')]'
data_block = '//div[@class="timeline-event-bubble-title"]/../..//div[@class="timeline-event-bubble-body"]'
image

Returns the image name of an event.

window_loc = '//div[@class="timeline-event-bubble-title"]/../..'
class cfme.web_ui.jstimelines.Object(element)[source]

Bases: utils.pretty.Pretty

A generic timelines object.

Parameters:element – A WebElement for the event.
locate()[source]
pretty_attrs = ['element']
cfme.web_ui.jstimelines.events()[source]

A generator yielding all events.

cfme.web_ui.jstimelines.find_visible_events_for_vm(vm_name)[source]

Finds all events for a given vm.

Parameters:vm_name – The vm name.
cfme.web_ui.listaccordion module

A set of functions for dealing with accordions in the UI.

Usage:

Using Accordions is simply a case of either selecting it to return the element,
or using the built in click method. As shown below::

  acc = web_ui.accordion

  acc.click('Diagnostics')
  acc.is_active('Diagnostics')

Note

Inactive links are not available in any way.

Bases: utils.pretty.Pretty

Active link in an accordion section

Parameters:title – The title of the link.
click()[source]

Clicks a link by title.

Parameters:title – The title of the button to check.
Raises:ListAccordionLinkNotFound – when active link is not found.
is_selected()[source]

Looks whether this option is selected

locate()[source]

Locates an active link.

Returns: An XPATH locator for the element.

pretty_attrs = ['title', 'root']
cfme.web_ui.listaccordion.click(name)[source]

Clicks an accordion and returns it

Parameters:name – The name of the accordion.

Returns all active links in a section specified by name

This is only used in pagestats and is likely to be deprecated

Parameters:name – Name of the section
cfme.web_ui.listaccordion.is_active(name)[source]

Checks if an accordion is currently open

Parameters:name – The name of the accordion.

Returns: True if the button is depressed, False if not.

cfme.web_ui.listaccordion.is_selected(name, link_title_or_text, by_title=True, partial=False)[source]

Checks if the link in accordion section is selected

Parameters:
  • name – Name of the accordion.
  • link_title_or_text – Title or text of link in expanded accordion section.
  • by_title – Whether to search by title or by text.
cfme.web_ui.listaccordion.locate(name)[source]

Returns a list-accordion by name

Parameters:name – The name of the accordion.

Returns: An xpath locator of the selected accordion.

cfme.web_ui.listaccordion.select(name, link_title_or_text, by_title=True, partial=False)[source]

Clicks an active link in accordion section

Parameters:
  • name – Name of the accordion.
  • link_title_or_text – Title or text of link in expanded accordion section.
  • by_title – Whether to search by title or by text.
cfme.web_ui.mixins module
cfme.web_ui.mixins.add_tag(tag, single_value=False, navigate=True)[source]
cfme.web_ui.mixins.get_tags(tag='My Company Tags')[source]
cfme.web_ui.mixins.remove_tag(tag)[source]
cfme.web_ui.multibox module
class cfme.web_ui.multibox.Async(value)[source]

Bases: utils.category.CategoryBase

class cfme.web_ui.multibox.MultiBoxSelect(unselected, selected, to_unselected, to_selected, remove_all=None, sync=None, async=None)[source]

Bases: utils.pretty.Pretty

Common UI element for selecting multiple items.

Presence in eg. Control/Explorer/New Policy Profile (for selecting policies)

Parameters:
  • unselected – Locator for the left (unselected) list of items.
  • selected – Locator for the right (selected) list of items.
  • to_unselected – Locator for a button which moves items from right to left (unselecting)
  • to_selected – Locator for a button which moves items from left to right (selecting)
  • remove_all – If present, locator for a button which unselects all items (Default None)
add(*values, **kwargs)[source]

Mark items for selection and then clicks the button to select them.

Parameters:*values – Values to select
Keywords:
flush: By using flush keyword, the selected items list is flushed prior to selecting
new ones

Returns: bool with success.

all_selected
classmethod categorize(values, sync_l, async_l, dont_care_l)[source]

Does categorization of values based on their Sync/Async status.

Parameters:
  • values – Values to be categorized.
  • sync_l – List that will be used for appending the Sync values.
  • async_l – List that will be used for appending the Async values.
  • dont_care_l – List that will be used for appending all the other values.
classmethod default()[source]

The most common type of the MultiBoxSelect

Returns: MultiBoxSelect instance

pretty_attrs = ['unselected', 'selected']
remove(*values)[source]

Mark items for deselection and then clicks the button to deselect them.

Parameters:*values – Values to deselect

Returns: bool with success.

remove_all()[source]

Flush the list of selected items.

Returns: bool with success.

set_async(*values)[source]
set_sync(*values)[source]
class cfme.web_ui.multibox.SelectItem(sync, value, text)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

sync

Alias for field number 0

text

Alias for field number 2

value

Alias for field number 1

class cfme.web_ui.multibox.Sync(value)[source]

Bases: utils.category.CategoryBase

cfme.web_ui.paginator module

A set of functions for dealing with the paginator controls.

cfme.web_ui.paginator.check_all()[source]

selects all items

cfme.web_ui.paginator.first()[source]

Returns the First button locator.

cfme.web_ui.paginator.last()[source]

Returns the Last button locator.

cfme.web_ui.paginator.new_paginator()[source]

Simple function to avoid module level import

cfme.web_ui.paginator.next()[source]

Returns the Next button locator.

cfme.web_ui.paginator.page_controls_exist()[source]

Simple check to see if page controls exist.

cfme.web_ui.paginator.pages()[source]

A generator to facilitate looping over pages

Usage:

for page in pages():
    # Do seleniumy things here, like finding and clicking elements
Raises:ValueError – When the paginator “breaks” (does not change)
cfme.web_ui.paginator.previous()[source]

Returns the Previous button locator.

cfme.web_ui.paginator.rec_end()[source]

Returns the record set index.

cfme.web_ui.paginator.rec_offset()[source]

Returns the first record offset.

cfme.web_ui.paginator.rec_total()[source]

Returns the total number of records.

cfme.web_ui.paginator.reset()[source]

Reset the paginator to the first page or do nothing if no pages

cfme.web_ui.paginator.results_per_page(num)[source]

Changes the number of results on a page.

Parameters:num – Number of results per page
cfme.web_ui.paginator.sort_by(sort)[source]

Changes the sort by field.

Parameters:sort – Value to sort by (visible text in select box)
cfme.web_ui.paginator.uncheck_all()[source]

unselects all items

cfme.web_ui.search module

This module operates the Advanced search box located on multiple pages.

exception cfme.web_ui.search.DisabledButtonException(*args, **kwargs)[source]

Bases: exceptions.Exception

cfme.web_ui.search.apply_filter()[source]

Applies an existing filter

cfme.web_ui.search.check_and_click_close()[source]

Check for display of advanced search close button and click it

cfme.web_ui.search.check_and_click_open()[source]

Check for display of advanced search open button and click it

cfme.web_ui.search.delete_filter(cancel=False)[source]

If possible, deletes the currently loaded filter.

cfme.web_ui.search.ensure_advanced_search_closed()[source]

Checks if the advanced search box is open and if it does, closes it.

cfme.web_ui.search.ensure_advanced_search_open()[source]

Make sure the advanced search box is opened.

If the advanced search box is closed, open it if it exists (otherwise exception raised).

cfme.web_ui.search.ensure_no_filter_applied()[source]

If any filter is applied in the quadicon view, it will be disabled.

cfme.web_ui.search.ensure_normal_search_empty()[source]

Makes sure that the normal search field is empty.

cfme.web_ui.search.fill_and_apply_filter(expression_program, fill_callback=None, cancel_on_user_filling=False)[source]

Fill the filtering expression and apply it

Parameters:
  • expression_program – Expression to fill to the filter.
  • fill_callback – Function to be called for each asked user input (_process_user_filling()).
cfme.web_ui.search.fill_expression(expression_program)[source]

Wrapper to open the box and fill the expression

Parameters:expression_program – the expression to be filled.
cfme.web_ui.search.is_advanced_filter_applied()[source]

Checks whether any filter is in effect on quadicon view

cfme.web_ui.search.is_advanced_search_opened()[source]

Checks whether the advanced search box is currently opened

cfme.web_ui.search.is_advanced_search_possible()[source]

Checks for advanced search possibility in the quadicon view

cfme.web_ui.search.load_and_apply_filter(saved_filter=None, report_filter=None, fill_callback=None, cancel_on_user_filling=False)[source]

Load the filtering expression and apply it

Parameters:
  • saved_filter – Choose a saved XYZ filter.
  • report_filter – Choose a XYZ report filter.
  • fill_callback – Function to be called for each asked user input.
cfme.web_ui.search.load_filter(saved_filter=None, report_filter=None, cancel=False)[source]

Load saved filter

Parameters:
  • saved_filter – Choose a saved XYZ filter
  • report_filter – Choose a XYZ report filter
  • cancel – Whether to cancel the load dialog without loading

Do normal search via the search bar.

Parameters:search_term – What to search.
cfme.web_ui.search.reset_filter()[source]

Clears the filter expression

Returns result of clicking reset when enabled Returns false when reset is button is disabled

cfme.web_ui.search.save_and_apply_filter(expression_program, save_name, global_search=False)[source]
cfme.web_ui.search.save_filter(expression_program, save_name, global_search=False, cancel=False)[source]

Fill the filtering expression and save it

Parameters:
  • expression_program – the expression to be filled.
  • save_name – Name of the filter to be saved with.
  • global_search – Whether to check the Global search checkbox.
  • cancel – Whether to cancel the save dialog without saving
cfme.web_ui.splitter module
cfme.web_ui.splitter.pull_splitter_left()[source]
cfme.web_ui.splitter.pull_splitter_right()[source]
cfme.web_ui.tabstrip module

The tab strip manipulation which appears in Configure / Configuration and possibly other pages.

Usage:

import cfme.web_ui.tabstrip as tabs
tabs.select_tab("Authentication")
print(is_tab_selected("Authentication"))
print(get_selected_tab())
class cfme.web_ui.tabstrip.TabStripForm(fields=None, tab_fields=None, identifying_loc=None, order=None, fields_end=None)[source]

Bases: cfme.web_ui.Form

A class for interacting with tabstrip-contained Form elements on pages.

This behaves exactly like a Form, but is able to deal with form elements being broken up into tabs, accessible via a tab strip.

Parameters:
  • fields – A list of field name/locator tuples (same as Form implementation)
  • tab_fields – A dict with tab names as keys, and each key’s value being a list of field name/locator tuples. The ordering of fields within a tab is guaranteed (as it is with the normal Form) but the ordering of tabs is not guaranteed by default. If such ordering is needed, tab_fields can be a collections.OrderedDict.
  • identifying_loc – A locator which should be present if the form is visible.
  • order – If specified, specifies order of the tabs. Can be lower number than number of tabs, remaining values will be complemented.
  • fields_end – Same as fields, but these are appended at the end of generated fields instead.

Usage:

provisioning_form = web_ui.TabStripForm(
    tab_fields={
        'Request': [
            ('email', Input("requester__owner_email")),
            ('first_name', Input("requester__owner_first_name")),
            ('last_name', Input("requester__owner_last_name")),
            ('notes', '//textarea[@id="requester__request_notes"]'),
        ],
        'Catalog': [
            ('instance_name', Input("service__vm_name")),
            ('instance_description', '//textarea[@id="service__vm_description"]'),
        ]
    }
)

Each tab’s fields will be exposed by their name on the resulting instance just like fields on a Form. Don’t use duplicate field names in the tab_fields dict.

Forms can then be filled in like so:

request_info = {
    'email': 'your@email.com',
    'first_name': 'First',
    'last_name': 'Last',
    'notes': 'Notes about this request',
    'instance_name': 'An instance name',
    'instance_description': 'This is my instance!',
}
web_ui.fill(provisioning_form, request_info)
cfme.web_ui.tabstrip.get_all_tabs()[source]

Return list of all tabs present.

Returns: list of str Displayed names.

cfme.web_ui.tabstrip.get_clickable_tab(ident_string)[source]

Returns the relevant tab element that can be clicked on.

Parameters:ident_string – The text diplayed on the tab.
cfme.web_ui.tabstrip.get_selected_tab()[source]

Return currently selected tab.

Returns: str Displayed name

cfme.web_ui.tabstrip.is_tab_element_selected(element)[source]

Determine whether the passed element is selected.

This function takes the element, climbs to its parent and looks whether the aria-selected attribute contains true. If yes, element is selected.

Parameters:element – WebElement with the link (a)

Returns: bool

cfme.web_ui.tabstrip.is_tab_selected(ident_string)[source]

Determine whether the element identified by passed name is selected.

Parameters:ident_string – Identification string (displayed name) of the tab button.

Returns: bool

cfme.web_ui.tabstrip.select_tab(ident_string)[source]

Clicks on the tab with text from ident_string.

Clicks only if it’s not actually selected.

Parameters:ident_string – The text displayed on the tab.
cfme.web_ui.timelines module
class cfme.web_ui.timelines.Timelines(o)[source]

Bases: object

Represents Common UI Page for showing generated events of different Providers as a timeline. UI page contains several drop-down items which are doing filtering of displayed events. In this class, there are described several methods to change those filters. After each filter change, UI page is reloaded and the displayed events graphic is changed. And after each page reload, the displayed events are re-read by this class. The main purpose of this class is to check whether particular event is displayed or not in timelines page.

Usage:

timelines.change_interval('Days')
timelines.select_event_category('Application')
timelines.check_detailed_events(True)
timelines.contains_event('hawkular_deployment.ok')
change_date(value)[source]
change_event_type(value)[source]
change_interval(value)[source]
check_detailed_events(value)[source]
contains_event(event_type, date_after=datetime.datetime(1, 1, 1, 0, 0))[source]

Checks whether list of events contains provided particular ‘event_type’ with data not earlier than provided ‘date_after’. If ‘date_after’ is not provided, will use datetime.min.

reload()[source]
select_event_category(value)[source]
cfme.web_ui.toolbar module

A set of functions for dealing with the toolbar buttons

The main CFME toolbar is accessed by using the Root and Sub titles of the buttons.

Usage:

tb = web_ui.toolbar
tb.select('Configuration', 'Add a New Host')
cfme.web_ui.toolbar.exists(root, sub=None, and_is_not_greyed=False)[source]

Checks presence and usability of toolbar buttons.

By default it checks whether the button is available, not caring whether it is greyed or not. You can optionally enable check for greyedness.

Parameters:
  • root – Button name.
  • sub – Item name (optional)
  • and_is_not_greyed – Check if the button is available to click.
cfme.web_ui.toolbar.is_active(root)[source]

Checks if a button is currently depressed

Parameters:root – The root button’s name as a string.

Returns: True if the button is depressed, False if not.

cfme.web_ui.toolbar.is_greyed(root, sub=None)[source]

Checks if a button is greyed out.

Parameters:root – The root button’s name as a string.

Returns: True if the button is greyed, False if not.

cfme.web_ui.toolbar.old_select(root, sub=None, invokes_alert=False)[source]

Clicks on a button by calling the dhtmlx toolbar callEvent.

Parameters:
  • root – The root button’s name as a string.
  • sub – The sub button’s name as a string. (optional)
  • invokes_alert – If True, then the behaviour is little bit different. After the last click, no ajax wait and no move away is done to be able to operate the alert that appears after click afterwards. Defaults to False.

Returns: True if everything went smoothly Raises: cfme.exceptions.ToolbarOptionGreyedOrUnavailable

cfme.web_ui.toolbar.pf_select(root, sub=None, invokes_alert=False)[source]

Clicks on a button by calling the click event with the jquery trigger.

Parameters:
  • root – The root button’s name as a string.
  • sub – The sub button’s name as a string. (optional)
  • invokes_alert – If True, then the behaviour is little bit different. After the last click, no ajax wait and no move away is done to be able to operate the alert that appears after click afterwards. Defaults to False.

Returns: True if everything went smoothly Raises: cfme.exceptions.ToolbarOptionGreyedOrUnavailable

cfme.web_ui.toolbar.refresh()[source]

Refreshes page, attempts to use cfme refresh button otherwise falls back to browser refresh.

cfme.web_ui.toolbar.root_loc(root)[source]

Returns the locator of the root button

Parameters:root – The string name of the button.

Returns: A locator for the root button.

cfme.web_ui.toolbar.select(*args, **kwargs)[source]
cfme.web_ui.toolbar.select_n_move(el)[source]

Clicks an element and then moves the mouse away

This is required because if the button is active and we clicked it, the CSS class doesn’t change until the mouse is moved away.

Parameters:el – The element to click on.

Returns: None

cfme.web_ui.toolbar.sub_loc(sub)[source]

Returns the locator of the sub button

Parameters:sub – The string name of the button.

Returns: A locator for the sub button.

cfme.web_ui.toolbar.xpath_quote(x)[source]

Putting strings in xpath requires unescape also

cfme.web_ui.topology module
class cfme.web_ui.topology.Topology(o)[source]

Bases: object

ELEMENTS = '//kubernetes-topology-graph//*[name()="g"]'
LEGENDS = '//kubernetes-topology-icon'
LINES = '//kubernetes-topology-graph//*[name()="line"]'
__iter__()[source]

This enables you to iterate through like it was a dictionary, just without .iteritems

elements(element_type=None)[source]
legends
lines(connection=None)[source]
refresh()[source]
reload()[source]
reload_elements()[source]
class cfme.web_ui.topology.TopologyDisplayNames[source]

Bases: object

DISPLAY_NAME = '//*[contains(@class, \'container_topology\')]//label[contains(., \'Display Names\')]/input|//*[@id="box_display_names"]'
disable()[source]
enable(enable=True)[source]
is_enabled
class cfme.web_ui.topology.TopologyElement(o, element)[source]

Bases: object

children
double_click()[source]
is_displayed()[source]
is_hidden
parents
class cfme.web_ui.topology.TopologyLegend(name, element)[source]

Bases: object

is_active
name
set_active(active=True)[source]
class cfme.web_ui.topology.TopologyLine(element)[source]

Bases: object

class cfme.web_ui.topology.TopologySearchBox[source]

Bases: object

SEARCH_BOX = "//input[@id='search_topology']|//input[@id='search']"
SEARCH_CLEAR = "//button[contains(@class, 'clear')]"
SEARCH_SUBMIT = "//button[contains(@class, 'search-topology-button')]"
clear()[source]
submit()[source]
text(submit=True, text=None)[source]
cfme.web_ui.utilization module
class cfme.web_ui.utilization.Legend(name, legend_object)[source]

Bases: object

This class used to control/read legends

is_active

Returns True if the legend is on active state, otherwise False

name

User friendly name of the legend

set_active(active=True)[source]

Enable or Disable legend

Parameters:active – When we set True, Enables the legend. When we set False disables the legend. Default True
class cfme.web_ui.utilization.LineChart(chart_id, name, utilization_object)[source]

Bases: object

LineChart supports to do actions on line chart

LEGENDS = "//*[name()='g']//*[contains(@class, 'c3-legend-item ') or @class='c3-legend-item']"
__iter__()[source]

This enables you to iterate through like it was a dictionary, just without .iteritems

has_warning
is_on_chart_page

Returns True we we are in detailed chart page, otherwise False

key_ui_table_map = {'durable_subscripti': 'durable_subscription_count', 'non_durable_subscr': 'non_durable_subscription_count', 'non_durable_messag': 'non_durable_messages_count', 'delivering_message': 'delivering_message_count'}
legends

Returns available legends on chart

list_data_chart(raw=False)[source]

Returns list of data from chart

list_data_mgmt()[source]

Returns data from wrapanapi for the chart option selected

list_data_table(raw=False)[source]

Returns list of data from table

load_chart_reference(force_reload=False)[source]

Takes current page to chart detailed page

num_legend(only_enabled=True)[source]

Returns number of available legends on chart :param only_enabled: by default True, returns only enabled count when we pass True

option

Gives option object as property

class cfme.web_ui.utilization.Option(o)[source]

Bases: object

Option class used to control options on chart page

DD_BASE = "//dt[normalize-space(.)='{}']/following-sibling::dd"
IN_DAILY = 'Daily'
IN_HOURLY = 'Hourly'
IN_MOST_RECENT_HOUR = 'Most Recent Hour'
MN_10_MINUTE = '10 Minutes'
MN_15_MINUTE = '15 Minutes'
MN_30_MINUTE = '30 Minutes'
MN_45_MINUTE = '45 Minutes'
MN_60_MINUTE = '1 Hour'
RANGE = "//dt[normalize-space(.)='Range']/following-sibling::dd"
TIME_PROFILE = "//dt[normalize-space(.)='Time Profile']/following-sibling::dd"
WK_1_WEEK = '1 Week'
WK_2_WEEK = '2 Weeks'
WK_3_WEEK = '3 Weeks'
WK_4_WEEK = '4 Weeks'
get_date()[source]

Returns selected date from options

get_interval(force_visible_text=False)[source]

Returns selected interval from options

Parameters:force_visible_text – default it is False and returns internal value. If you want to get visible text pass this value as True
get_minute(force_visible_text=False)[source]

Returns selected minute from options

Parameters:force_visible_text – default it is False and returns internal value. If you want to get visible text pass this value as True
get_range()[source]

Returns selected range from options

get_time_profile()[source]

Returns selected time profile from options

get_week(force_visible_text=False)[source]

Returns selected week from options

Parameters:force_visible_text – default it is False and returns internal value. If you want to get visible text pass this value as True
set_by_value(op_interval=None, op_date=None, op_week=None, op_minute=None)[source]

Set options by internal value :param op_minute: Minute option :param op_date: Date option, date format should be as ‘MM/DD/YYYY’, ie: 11/21/2016 :param op_interval: Set interval :param op_week: Set week

set_by_visible_text(op_interval=None, op_date=None, op_week=None, op_minute=None)[source]

Set options by visible text :param op_minute: Minute option :param op_date: Date option, date format should be as ‘MM/DD/YYYY’, ie: 11/21/2016 :param op_interval: Set interval :param op_week: Set week

to_string()[source]

Returns selected options as string

class cfme.web_ui.utilization.Utilization(o)[source]

Bases: object

Utilization class is the top level class for chart management in Middleware. We have to create Utilization with reference of any page which has Utilization >> Monitoring tab. Reference page must have implemented load_utilization_page() function which will take to Monitoring page.

__iter__()[source]

This enables you to iterate through like it was a dictionary, just without .iteritems

charts

Returns available charts on monitoring page

load_utilization_page(refresh=True)[source]
page

Returns page object of caller

reload(force_reload=False)[source]

Reload the entire page

cfme.web_ui.utilization.round_double(value, precision=2)[source]

Round double value with precision limit

cfme.web_ui.utilization.value_of(text_value, remove_comma=True)[source]

Converts string value to Int, Float or String :param remove_comma: When we set this value as True, :param removes all comma from the string. Default True:

Module contents

Provides a number of objects to help with managing certain elements in the CFME UI.

Specifically there are two categories of objects, organizational and elemental.
class cfme.web_ui.AngularCalendarInput(input_name, click_away_element)[source]

Bases: utils.pretty.Pretty

clear()[source]
clear_button
fill(value)[source]
input
locate()[source]
pretty_attrs = ('input_name', 'click_away_element')
class cfme.web_ui.AngularSelect(loc, none=None, multi=False, exact=False)[source]

Bases: utils.pretty.Pretty

BUTTON = "//button[@data-id='{}']"
all_options
classes

Combines class from the button and from select.

did
first_selected_option
first_selected_option_text
is_broken
is_open
locate()[source]
open()[source]
options
pretty_attrs = ['_loc', 'none', 'multi', 'exact']
select
select_by_value(value)[source]
select_by_visible_text(text)[source]
class cfme.web_ui.BootstrapSwitch(input_id)[source]

Bases: object

angular_help_block

Returns the first visible angular helper text (like ‘Required’).

check()[source]

Checks the bootstrap box

fill(val)[source]

Convenience function

is_selected()[source]
uncheck()[source]

Unchecks the bootstrap box

class cfme.web_ui.BootstrapTreeview(tree_id)[source]

Bases: object

A class representing the Bootstrap treeview used in newer builds.

Implements expand_path, click_path, read_contents. All are implemented in manner very similar to the original Tree.

Parameters:tree_id – Id of the tree, the closest div to the root ul element.
CHILD_ITEMS = './ul/li[starts-with(@data-nodeid, {id}) and count(./span[contains(@class, "indent")])={indent}]'
CHILD_ITEMS_TEXT = './ul/li[starts-with(@data-nodeid, {id}) and contains(normalize-space(.), {text}) and count(./span[contains(@class, "indent")])={indent}]'
INDENT = './span[contains(@class, "indent")]'
IS_CHECKABLE = './span[contains(@class, "check-icon")]'
IS_CHECKED = './span[contains(@class, "check-icon") and contains(@class, "fa-check-square-o")]'
IS_EXPANDABLE = './span[contains(@class, "expand-icon")]'
IS_EXPANDED = './span[contains(@class, "expand-icon") and contains(@class, "fa-angle-down")]'
IS_LOADING = './span[contains(@class, "expand-icon") and contains(@class, "fa-spinner")]'
ITEM_BY_NODEID = './ul/li[@data-nodeid={}]'
ROOT_ITEMS = './ul/li[not(./span[contains(@class, "indent")])]'
ROOT_ITEMS_WITH_TEXT = './ul/li[not(./span[contains(@class, "indent")]) and contains(normalize-space(.), {text})]'
SELECTED_ITEM = './ul/li[contains(@class, "node-selected")]'
check_node(*path, **kwargs)[source]

Expands the passed path and checks a checkbox that is located at the node.

check_uncheck_node(check, *path, **kwargs)[source]
child_items(item=None)[source]
child_items_with_text(item, text)[source]
click_path(*path, **kwargs)[source]

Expands the path and clicks the leaf node.

See expand_path() for more informations about synopsis.

collapse_node(nodeid)[source]

Collapses a node given its nodeid. Must be visible

Parameters:nodeid – nodeId of the node
Returns:True if it was possible to expand the node, otherwise False.
expand_node(nodeid)[source]

Expands a node given its nodeid. Must be visible

Parameters:nodeid – nodeId of the node
Returns:True if it was possible to expand the node, otherwise False.
expand_path(*path, **kwargs)[source]

Expands given path and returns the leaf node.

The path items can be plain strings. In that case, exact string matching happens. Path items can also be compiled regexps, where the match method is used to determine if the node is the one we want. And finally, the path items can be 2-tuples, where the second item can be the string or regular expression and the first item is the image to be matched using image_getter() method.

Parameters:*path – The path (explained above)
Returns:The leaf WebElement.
Raises:exceptions.CandidateNotFound when the node is not found in the tree.
find_path_to(target, exact=False)[source]

Method used to look up the exact path to an item we know only by its regexp or partial description.

Expands whole tree during the execution.

Parameters:
  • target – Item searched for. Can be regexp made by re.compile, otherwise it is taken as a string for in matching.
  • exact – Useful in string matching. If set to True, it matches the exact string. Default is False.

Returns: list with path to that item.

classmethod get_expand_arrow(item)[source]
get_item_by_nodeid(nodeid)[source]
classmethod get_nodeid(item)[source]
classmethod image_getter(item)[source]

Look up the image that is hidden in the style tag

Returns:The name of the image without the hash, path and extension.
classmethod indents(item)[source]
classmethod is_checkable(item)[source]
classmethod is_checked(item)[source]
classmethod is_collapsed(item)[source]
classmethod is_expandable(item)[source]
classmethod is_expanded(item)[source]
classmethod is_loading(item)[source]
classmethod is_selected(item)[source]
locate()[source]
node_checked(*path, **kwargs)[source]

Check if a checkbox is checked on the node in that path.

classmethod pretty_path(path)[source]
read_contents(nodeid=None, include_images=False, collapse_after_read=False)[source]
selected_item
uncheck_node(*path, **kwargs)[source]

Expands the passed path and unchecks a checkbox that is located at the node.

classmethod validate_node(node, matcher, image)[source]
class cfme.web_ui.ButtonGroup(key, fieldset=None)[source]

Bases: object

active

Returns the alt tag text of the active button in thr group.

choose(alt)[source]

Sets the ButtonGroup to select the button identified by the alt text.

locate()[source]

Moves to the element

locator
locator_base
status(alt)[source]

Returns the status of the button identified by the Alt Text of the image.

class cfme.web_ui.CAndUGroupTable(table_locator, header_offset=0, body_offset=0, hidden_locator=None)[source]

Bases: cfme.web_ui.Table

Type of tables used in C&U, not tested in others.

Provides .groups() generator which yields group objects. A group objects consists of the rows that are located in the group plus the summary informations. THe main principle is that all the rows inside group are stored in group object’s .rows and when the script encounters the end of the group, it will store the summary data after the data rows as attributes, so eg. Totals: will become group.totals. All the rows are represented as dictionaries.

class Group(group_id, headers, rows, info_rows)[source]

Bases: object

class CAndUGroupTable.States[source]
GROUP_SUMMARY = 1
NORMAL_ROWS = 0
CAndUGroupTable.find_group(group_id)[source]

Finds a group by its group ID (the string that is alone on the line)

CAndUGroupTable.groups()[source]
CAndUGroupTable.paginated_rows()[source]
class cfme.web_ui.CFMECheckbox(input_id)[source]

Bases: cfme.web_ui.Selector

decide()[source]
class cfme.web_ui.CachedTableHeaders(table)[source]

Bases: object

the internal cache of headers

This allows columns to be moved and the Table updated. The headers stores the header cache element and the list of headers are stored in _headers. The attribute header_indexes is then created, before finally creating the items attribute.

class cfme.web_ui.Calendar(name)[source]

Bases: utils.pretty.Pretty

A CFME calendar form field

Calendar fields are readonly, and managed by the dxhtmlCalendar widget. A Calendar field will accept any object that can be coerced into a string, but the value may not match the format expected by dhtmlxCalendar or CFME. For best results, either a datetime.date or datetime.datetime object should be used to create a valid date field.

Parameters:name – “name” property of the readonly calendar field.

Usage:

calendar = web_ui.Calendar("miq_date_1")
web_ui.fill(calendar, date(2000, 1, 1))
web_ui.fill(calendar, '1/1/2001')
locate()[source]
class cfme.web_ui.CheckboxSelect(search_root, text_access_func=None)[source]

Bases: utils.pretty.Pretty

Class used for filling those bunches of checkboxes I (@mfalesni) always hated to search for.

Can fill by values, text or both. To search the text for the checkbox, you have 2 choices:

  • If the text can be got from parent’s tag (like <div><input type=”checkbox”>blablabla</div>
    where blablabla is the checkbox’s description looked up), you can leave the text_access_func unfilled.
  • If there is more complicated layout and you don’t mind a bit slower operation, you can pass
    the text_access_func, which should be like lambda checkbox_el: get_text_of(checkbox_el). The checkbox WebElement is passed to it and the description text is the expected output of the function.
Parameters:
  • search_root – Root element for checkbox search
  • text_access_func – Function returning descriptive text about passed CB element.
check(values)[source]

Checking function.

Parameters:values – Dictionary with key=CB name, value=bool with status.

Look in the function to see.

checkbox_by_id(id)[source]

Find checkbox’s WebElement by id.

checkbox_by_text(text)[source]

Returns checkbox’s WebElement by searched by its text.

checkboxes

All checkboxes.

pretty_attrs = ['_root']
select_all()[source]

Selects all checkboxes.

selected_checkboxes

Only selected checkboxes.

selected_values

Only selected checkboxes’ values.

unselect_all()[source]

Unselects all checkboxes.

unselected_checkboxes

Only unselected checkboxes.

unselected_values

Only unselected checkboxes’ values.

class cfme.web_ui.CheckboxTable(table_locator, header_offset=0, body_offset=0, header_checkbox_locator=None, body_checkbox_locator=None)[source]

Bases: cfme.web_ui.Table

Table with support for checkboxes

Parameters:
  • table_locator – See cfme.web_ui.Table
  • header_checkbox_locator – Locator of header checkbox (default None) Specify in case the header checkbox is not part of the header row
  • body_checkbox_locator – Locator for checkboxes in body rows
  • header_offset – See cfme.web_ui.Table
  • body_offset – See cfme.web_ui.Table
deselect_all()[source]

Deselect all rows using the header checkbox or one by one if not present

deselect_row(header, value)[source]

Deselect a single row specified by column header and cell value

Parameters:

Returns: True if successful, False otherwise

deselect_row_by_cells(cells, partial_check=False)[source]

Deselect the first row matched by cells

Parameters:cells – See Table.find_rows_by_cells()
deselect_rows(cell_map)[source]

Deselect multiple rows

Parameters:cell_map – See Table.click_cells()
Raises:NotAllCheckboxesFound – If some cells were unable to be found
deselect_rows_by_cells(cells, partial_check=False)[source]

Deselect the rows matched by cells

Parameters:cells – See Table.find_rows_by_cells()
deselect_rows_by_indexes(*indexes)[source]

Deselect rows specified by row indexes (starting with 0)

header_checkbox

Checkbox used to select/deselect all rows

select_all()[source]

Select all rows using the header checkbox or one by one if not present

select_row(header, value)[source]

Select a single row specified by column header and cell value

Parameters:

Returns: True if successful, False otherwise

select_row_by_cells(cells, partial_check=False)[source]

Select the first row matched by cells

Parameters:cells – See Table.find_rows_by_cells()
select_rows(cell_map)[source]

Select multiple rows

Parameters:cell_map – See Table.click_cells()
Raises:NotAllCheckboxesFound – If some cells were unable to be found
select_rows_by_cells(cells, partial_check=False)[source]

Select the rows matched by cells

Parameters:cells – See Table.find_rows_by_cells()
select_rows_by_indexes(*indexes)[source]

Select rows specified by row indexes (starting with 0)

class cfme.web_ui.CheckboxTree(locator)[source]

Bases: cfme.web_ui.Tree

Tree that has a checkbox on each node, adds methods to check/uncheck them

check_node(*path)[source]

Convenience function to check a node

Parameters:*path – The path as multiple positional string arguments denoting the course to take.
node_checkbox = "../span[@class='dynatree-checkbox']"
uncheck_node(*path)[source]

Convenience function to uncheck a node

Parameters:*path – The path as multiple positional string arguments denoting the course to take.
class cfme.web_ui.ColorGroup(key)[source]

Bases: object

active

Returns the alt tag text of the active button in thr group.

choose(color)[source]

Sets the ColorGroup to select the button identified by the title text.

locate()[source]

Moves to the element

status(color)[source]

Returns the status of the color button identified by the Title Text of the image.

class cfme.web_ui.DHTMLSelect(loc, multi=False, none=None)[source]

Bases: cfme.fixtures.pytest_selenium.Select

A special Select object for CFME’s icon enhanced DHTMLx Select elements.

Parameters:loc – A locator.

Returns a cfme.web_ui.DHTMLSelect object.

all_selected_options

Returns all selected options.

Note: Since the DHTML select can only have one option selected at a time, we
simple return the first element (the only element).

Returns: A Web element.

first_selected_option

Returns the first selected option in the DHTML select

Note: In a DHTML select, there is only one option selectable at a time.

Returns: A webelement.

locate()[source]
options

Returns a list of options of the select as webelements.

Returns: A list of Webelements.

select_by_index(index, _cascade=None)[source]

Selects an option by index.

Parameters:index – The select element’s option by index.
select_by_value(value, _cascade=None)[source]

Selects an option by value.

Parameters:value – The select element’s option value.
select_by_visible_text(text)[source]

Selects an option by visible text.

Parameters:text – The select element option’s visible text.
class cfme.web_ui.DriftGrid(loc="//div[@id='compare-grid']")[source]

Bases: utils.pretty.Pretty

Class representing the table (grid) specific to host drift analysis comparison page

cell_indicates_change(row_text, col_index)[source]

Finds out if a cell, specified by column index and row text, indicates change

Parameters:
  • row_text – Title text of the cell’s row
  • col_index – Column index of the cell

Note

col_index of 0 is used for the 2nd actual column in the drift grid, because the 1st column does not contain headers, only row descriptions.

Returns:True if there is a change present, False otherwise
expand_all_sections()[source]

Expands all sections to make the row elements found therein available

get_cell(row_text, col_index)[source]

Finds cell element of the grid specified by column index and row text

Parameters:
  • row_text – Title text of the cell’s row
  • col_index – Column index of the cell, starting with 0 for 1st data-containing column

Note

col_index of 0 is used for the 2nd actual column in the drift grid, because the 1st column does not contain headers, only row descriptions.

Returns:Selenium element of the cell.
class cfme.web_ui.DynamicTable(root_loc, default_row_item=None)[source]

Bases: utils.pretty.Pretty

A table that can add or remove the rows.

DELETE_ALL = {Version('lowest'): ".//tbody/tr/td/img[@alt='Delete']", '5.6': './/tbody/tr/td/button/i[contains(@class, "minus")]'}
ROWS = ".//tbody/tr[not(contains(@id, 'new_tr'))]"
class Row(table, root)[source]

Bases: object

inputs
inputs_for_filling
values
DynamicTable.add_row(data)[source]
DynamicTable.clear()[source]
DynamicTable.click_add()[source]
DynamicTable.click_save()[source]
DynamicTable.delete_row(by)[source]
DynamicTable.header_names
DynamicTable.pretty_attrs = ('root_loc', 'default_row_item')
DynamicTable.rows
class cfme.web_ui.EmailSelectForm[source]

Bases: utils.pretty.Pretty

Class encapsulating the e-mail selector, eg. in Control/Alarms editing.

fields = <cfme.web_ui.Region title=None>
remove_email(email)[source]

Remove specified e-mail

Parameters:email – E-mail to remove
to_emails

Returns list of e-mails that are selected

user_emails

Returns list of e-mail that users inside CFME have so that they can be selected

class cfme.web_ui.FileInput(*names, **kwargs)[source]

Bases: cfme.web_ui.Input

A file input handling widget.

Accepts a string. If the string is a file, then it is put in the input. Otherwise a temporary file is generated and that one is fed to the file input.

class cfme.web_ui.Filter(fields=None, identifying_loc=None)[source]

Bases: cfme.web_ui.Form

Filters requests pages

This class inherits Form as its base and adds a few methods to assist in filtering request pages.

Usage:

f = Filter(fields=[
    ('type', Select('//select[@id="type_choice"]')),
    ('approved', Input("state_choice__approved")),
    ('denied', Input"state_choice__denied")),
    ('pending_approval', Input("state_choice__pending_approval")),
    ('date', Select('//select[@id="time_period"]')),
    ('reason', Input("reason_text")),
])

f.apply_filter(type="VM Clone", approved=False,
    pending_approval=False, date="Last 24 Hours", reason="Just Because")
apply_filter(**kwargs)[source]

Method to apply a filter.

First resets the filter to default and then applies the filter.

Parameters:**kwargs – A dictionary of form elements to fill and their values.
buttons = {'reset': '//div[@id="buttons_on"]//a[@title="Reset filter changes"]', 'apply': '//div[@id="buttons_on"]//a[@title="Apply the selected filters"]', 'default_off': '//div[@id="buttons_off"]/li/a/img[@alt="Set filters to default"]', 'default_on': '//div[@id="buttons_on"]/li/a/img[@alt="Set filters to default"]'}
default_filter()[source]

Method to reset the filter back to defaults.

reset_filter()[source]

Method to reset the changes to the filter since last applying.

class cfme.web_ui.Form(fields=None, identifying_loc=None)[source]

Bases: cfme.web_ui.Region

A class for interacting with Form elements on pages.

The Form class takes a set of locators and binds them together to create a unified Form object. This Form object has a defined field order so that the user does not have to worry about which order the information is provided. This enables the data to be provided as a dict meaning it can be passed directly from yamls. It inherits the base Region class, meaning that locators can still be referenced in the same way a Region’s locators can. You can also add one more field which will be a dict of metadata, determining mostly field validity. See field_valid()

Parameters:
  • fields – A list of field name/locator tuples. The argument not only defines the order of the elements but also which elements comprise part of the form.
  • identifying_loc – A locator which should be present if the form is visible.

Usage:

provider_form = web_ui.Form(
    fields=[
        ('type_select', "//*[@id='server_emstype']"),
        ('name_text', "//*[@id='name']"),
        ('hostname_text', "//*[@id='hostname']"),
        ('ipaddress_text', "//*[@id='ipaddress']"),
        ('amazon_region_select', "//*[@id='hostname']"),
        ('api_port', "//*[@id='port']"),
    ])

Forms can then be filled in like so.:

provider_info = {
   'type_select': "OpenStack",
   'name_text': "RHOS-01",
   'hostname_text': "RHOS-01",
   'ipaddress_text': "10.0.0.0",
   'api_port': "5000",
}
web_ui.fill(provider_form, provider_info)

Note

Using supertuples in a list, although ordered due to the properties of a List, will not overide the field order defined in the Form.

field_valid(field_name)[source]

Add the validity constraints here.

fill(fill_data)[source]
pretty_attrs = ['fields']
class cfme.web_ui.InfoBlock(title)[source]

Bases: utils.pretty.Pretty

DETAIL = 'detail'
FORM = 'form'
class Member(ib, name)[source]

Bases: utils.pretty.Pretty

container
element
elements
icon_href
locate()[source]
pair
pair_locator
pretty_attrs = ('name', 'ib')
text
title
InfoBlock.PF = 'patternfly'
InfoBlock.__call__(member)[source]

A present for @smyers

InfoBlock.by_member_icon(icon)[source]

In case you want to find the item by icon in the value field (like OS infra diff.)

classmethod InfoBlock.container(args, **kwargs)[source]
classmethod InfoBlock.element(*args, **kwargs)[source]
classmethod InfoBlock.elements(*args, **kwargs)[source]
classmethod InfoBlock.icon_href(*args, **kwargs)[source]
InfoBlock.member(name)[source]
InfoBlock.pretty_attrs = ['title']
InfoBlock.root
classmethod InfoBlock.text(*args, **kwargs)[source]
InfoBlock.type
class cfme.web_ui.Input(*names, **kwargs)[source]

Bases: utils.pretty.Pretty

Class designed to handle things about <input> tags that have name attr in one place.

Also applies on textarea, which is basically input with multiple lines (if it has name).

Parameters:*names – Possible values (or) of the name attribute.
Keywords:
use_id: Whether to use id instead of name. Useful if there is some input that does
not have name attribute present.
angular_help_block

Returns the first visible angular helper text (like ‘Required’).

locate()[source]
names
pretty_attrs = ['_names', '_use_id']
class cfme.web_ui.MultiFill(*fields)[source]

Bases: object

Class designed to fill the same value to multiple fields

Parameters:*fields – The fields where the value will be mirrored
class cfme.web_ui.MultiSelect(available_select=None, selected_select=None, select_arrow=None, deselect_arrow=None)[source]

Bases: cfme.web_ui.Region

Represents a UI widget where there are two select boxes, one with possible selections, and another with selected items. Has two arrow buttons to move items between the two

class cfme.web_ui.OldCheckbox(input_id)[source]

Bases: object

check()[source]

Convenience function

fill(val)[source]

Checks or unchecks

Parameters:value – The value the checkbox should represent as a bool (or None to do nothing)

Returns: Previous state of the checkbox

is_selected()[source]
uncheck()[source]

Convenience function

class cfme.web_ui.PagedTable(table_locator, header_offset=0, body_offset=0, hidden_locator=None)[source]

Bases: cfme.web_ui.Table

Table with support for paginator

Parameters:
  • table_locator – See cfme.web_ui.Table
  • header_checkbox_locator – Locator of header checkbox (default None) Specify in case the header checkbox is not part of the header row
  • body_checkbox_locator – Locator for checkboxes in body rows
  • header_offset – See cfme.web_ui.Table
  • body_offset – See cfme.web_ui.Table
find_row_by_cell_on_all_pages(cells)[source]

Find the first row containing cells on all pages

Parameters:cells – See Table.find_rows_by_cells()

Returns: The first matching row found on any page

find_row_on_all_pages(header, value)[source]
class cfme.web_ui.Quadicon(name, qtype=None)[source]

Bases: utils.pretty.Pretty

Represents a single quadruple icon in the CFME UI.

A Quadicon contains multiple quadrants. These are accessed via attributes. The qtype is currently one of the following and determines which attribute names are present. They are mapped internally and can be reassigned easily if the UI changes.

A Quadicon is used by defining the name of the icon and the type. After that, it can be used to obtain the locator of the Quadicon, or query its quadrants, via attributes.

Parameters:
  • name – The label of the icon.
  • qtype – The type of the quad icon. By default it is None, therefore plain quad without any retrievable data usable for selecting/clicking.

Usage:

qi = web_ui.Quadicon('hostname.local', 'host')
qi.creds
click(qi)

Known Quadicon Types and Attributes

  • host - from the infra/host page - has quads:
      1. no_vm - Number of VMs
      1. state - The current state of the host
      1. vendor - The vendor of the host
      1. creds - If the creds are valid
  • infra_prov - from the infra/providers page - has quads:
      1. no_host - Number of hosts
      1. Blank
      1. vendor - The vendor of the provider
      1. creds - If the creds are valid
  • vm - from the infra/virtual_machines page - has quads:
      1. os - The OS of the vm
      1. state - The current state of the vm
      1. vendor - The vendor of the vm’s host
      1. no_snapshot - The number of snapshots
      1. policy - The state of the policy
  • cloud_prov - from the cloud/providers page - has quads:
      1. no_instance - Number of instances
      1. no_image - Number of machine images
      1. vendor - The vendor of the provider
      1. creds - If the creds are valid
  • instance - from the cloud/instances page - has quads:
      1. os - The OS of the instance
      1. state - The current state of the instance
      1. vendor - The vendor of the instance’s host
      1. no_snapshot - The number of snapshots
      1. policy - The state of the policy
  • datastore - from the infra/datastores page - has quads:
      1. type - File system type
      1. no_vm - Number of VMs
      1. no_host - Number of hosts
      1. avail_space - Available space
  • cluster - from the infra/cluster page - has no quads
  • resource_pool - from the infra/resource_pool page - has no quads
  • stack - from the clouds/stacks page - has no quads

Returns: A Quadicon object.

QUADS = {'resource_pool': {}, 'infra_prov': {'no_host': ('a', 'txt'), 'vendor': ('c', 'img'), 'creds': ('d', 'img')}, 'image': {'vendor': ('c', 'img'), 'state': ('b', 'img'), 'os': ('a', 'img'), 'no_snapshot': ('d', 'txt')}, 'vm': {'policy': ('g', 'img'), 'vendor': ('c', 'img'), 'state': ('b', 'img'), 'os': ('a', 'img'), 'no_snapshot': ('d', 'txt')}, None: {}, 'cluster': {}, 'host': {'no_vm': ('a', 'txt'), 'vendor': ('c', 'img'), 'state': ('b', 'img'), 'creds': ('d', 'img')}, 'datastore': {'no_host': ('c', 'txt'), 'no_vm': ('b', 'txt'), 'type': ('a', 'img'), 'avail_space': ('d', 'img')}, 'stack': {}, 'middleware': {}, 'cloud_prov': {'no_vm': ('a', 'txt'), 'vendor': ('b', 'img'), 'creds': ('d', 'img'), 'no_image': ('b', 'txt')}, 'instance': {'policy': ('g', 'img'), 'vendor': ('c', 'img'), 'state': ('b', 'img'), 'os': ('a', 'img'), 'no_snapshot': ('d', 'txt')}, 'template': {'vendor': ('c', 'img'), 'state': ('b', 'img'), 'os': ('a', 'img'), 'no_snapshot': ('d', 'txt')}, 'object_store': {}}
__getattr__(name)[source]

Queries the quadrants by name

Parameters:name – The name of the quadrant identifier, as defined above.

Returns: A string containing a representation of what is in the quadrant.

a_cond
classmethod all(qtype=None, this_page=False)[source]

Allows iteration over Quadicons.

Parameters:
  • qtype – Quadicon type. Refer to the constructor for reference.
  • this_page – Whether to look for Quadicons only on current page (do not list pages).

Returns: list of Quadicon

classmethod any_present()[source]
check_for_single_quadrant_icon

Checks if the quad icon is a single quadrant icon.

checkbox()[source]

Returns: a locator for the internal checkbox for the quadicon

exists
classmethod first(qtype=None)[source]
static get_first_quad_title()[source]
href
locate()[source]

Returns: a locator for the quadicon anchor

name

Returns name of the quadicon.

pretty_attrs = ['_name', '_qtype']
qtype
static select_first_quad()[source]
class cfme.web_ui.Radio(*names, **kwargs)[source]

Bases: cfme.web_ui.Input

A class for Radio button groups

Radio allows the usage of HTML radio elements without resorting to previous practice of iterating over elements to find the value. The name of the radio group is passed and then when choices are required, the locator is built.

Parameters:name – The HTML elements name attribute that identifies a group of radio buttons.

Usage:

radio = Radio("schedule__schedule_type")

A specific radio element can then be returned by running the following:

el = radio.choice('immediately')
click(el)

The Radio object can be reused over and over with repeated calls to the Radio.choice() method.

choice(val)[source]

Returns the locator for a choice

Parameters:val – A string representing the value attribute of the specific radio element.

Returns: A string containing the XPATH of the specific radio element.

observer_wait(val)[source]
class cfme.web_ui.Region(locators=None, title=None, identifying_loc=None, **kwargs)[source]

Bases: utils.pretty.Pretty

Base class for all UI regions/pages

Parameters:
  • locators – A dict of locator objects for the given region
  • title – A string containing the title of the page, or a versioned dict of page title strings
  • identifying_loc – Single locator key from locators used by Region.is_displayed() to check if the region is currently visible

Usage:

page = Region(locators={
    'configuration_button': (By.CSS_SELECTOR, "div.dhx_toolbar_btn[title='Configuration']"),
    'discover_button': (By.CSS_SELECTOR,
        "tr[title='Discover Cloud Providers']>td.td_btn_txt>" "div.btn_sel_text")
    },
    title='Cloud Providers',
    identifying_loc='discover_button'
)

The elements can then accessed like so:

page.configuration_button

Locator attributes will return the locator tuple for that particular element, and can be passed on to other functions, such as element() and click().

Note

When specifying a region title, omit the “Cloudforms Management Engine: ” or “ManageIQ: ” prefix. They are included on every page, and different for the two versions of the appliance, and is_displayed() strips them off before checking for equality.

is_displayed()[source]

Checks to see if the region is currently displayed.

Returns: A boolean describing if the region is currently displayed

pretty_attrs = ['title']
title
class cfme.web_ui.ScriptBox(name=None, ta_locator="//textarea[contains(@id, 'method_data')]")[source]

Bases: utils.pretty.Pretty

Represents a script box as is present on the customization templates pages. This box has to be activated before keys can be sent. Since this can’t be done until the box element is visible, and some dropdowns change the element, it must be activated “inline”.

Args:

get_value()[source]
name
pretty_attrs = ['locator']
workaround_save_issue()[source]
class cfme.web_ui.Selector[source]

Bases: object

Special Selector object allowing object resolution on attr access

The Selector is a simple class which allows a ‘super’ widget to support multiple implementations. This is achieved by the use of a decide method which accesses attrs of the object set by the __init__ of the child class. These attributes are then used to decide which type of object is on a page. In some cases, this can avoid a version pick if the information used to instantiate both old and new implementations can be identical. This is most noteably if using an “id” which remains constant from implementation to implementation.

As an example, imagine the normal “checkbox” is replaced wit ha fancy new web 2.0 checkbox. Both have an “input” element, and give it the same “id”. When the decide method is invoked, the “id” is inspected and used to determine if it is an old or a new style widget. We then set a hidden attribute of the super widget and proxy all further attr requests to that object.

This means that in order for things to behave as expect ALL implementations must also expose the same “public” API.

decide()[source]
class cfme.web_ui.ShowingInputs(*locators, **kwargs)[source]

Bases: utils.pretty.Pretty

This class abstracts out as a container of inputs, that appear after preceeding was filled.

Parameters:*locators – In-order-of-display specification of locators.
Keywords:
min_values: How many values are required (Default: 0)
__getitem__(i)[source]

To delegate access to the separate locators

pretty_attrs = ['locators', 'min_values']
zip(with_values)[source]
class cfme.web_ui.SortTable(table_locator, header_offset=0, body_offset=0, hidden_locator=None)[source]

Bases: cfme.web_ui.Table

This table is the same as Table, but with added sorting functionality.

SORT_CELL = './th[./div/i[contains(@class, "fa-sort")] or contains(@class, "sorting_")]'
click_header_cell(text)[source]

Clicks on the header to change sorting conditions.

Parameters:text – Header cell text.
sort_by(header, order)[source]

Sorts the table by given conditions

Parameters:
  • header – Text of the header cell to use for sorting.
  • order – ascending or descending
sort_order

Return order.

Returns: ‘ascending’ or ‘descending’

sorted_by

Return column name what is used for sorting now.

class cfme.web_ui.SplitCheckboxTable(header_data, body_data, header_checkbox_locator=None, body_checkbox_locator=None)[source]

Bases: cfme.web_ui.SplitTable, cfme.web_ui.CheckboxTable

SplitTable with support for checkboxes

Parameters:
class cfme.web_ui.SplitPagedTable(header_data, body_data)[source]

Bases: cfme.web_ui.SplitTable, cfme.web_ui.PagedTable

SplitTable with support for paginator

Parameters:
class cfme.web_ui.SplitTable(header_data, body_data)[source]

Bases: cfme.web_ui.Table

Table that supports the header and body rows being in separate tables

Parameters:
  • header_data – A tuple, containing an element locator and an offset value. These point to the container of the header row. The offset is used in case there is a padding row above the header, or in the case that the header and the body are contained inside the same table element.
  • body_data – A tuple, containing an element locator and an offset value. These point to the container of the body rows. The offset is used in case there is a padding row above the body rows, or in the case that the header and the body are contained inside the same table element.

Usage:

table = SplitTable(header_data=('//div[@id="header_table"]//table/tbody', 0),
    body_data=('//div[@id="body_table"]//table/tbody', 1))

The HTML code for a split table looks something like this:

<div id="prov_pxe_img_div">
  <table id="header_table">
      <tbody>
          <tr>
              <td>Name</td>
              <td>Animal</td>
              <td>Size</td>
          </tr>
      </tbody>
  </table>
  <table id="body_table">
      <tbody>
          <tr>
              <td>Useless</td>
              <td>Padding</td>
              <td>Row</td>
          </tr>
          <tr>
              <td>John</td>
              <td>Monkey</td>
              <td>Small</td>
          </tr>
          <tr>
              <td>Mike</td>
              <td>Tiger</td>
              <td>Large</td>
          </tr>
      </tbody>
  </table>
</div>

Note the use of the offset to skip the “Useless Padding Row” in body_data. Most split tables require an offset for both the heading and body rows.

body

Property representing the element that contains body rows

header_row

Property representing the <tr> element that contains header cells

locate()[source]
class cfme.web_ui.StatusBox(name)[source]

Bases: object

Status box as seen in containers overview page

Status box modelling.

Parameters:name – The name of the status box as it appears in CFME, e.g. ‘Nodes’

Returns: A StatusBox instance.

value()[source]
class cfme.web_ui.Table(table_locator, header_offset=0, body_offset=0, hidden_locator=None)[source]

Bases: utils.pretty.Pretty

Helper class for Table/List objects

Turns CFME custom Table/Lists into iterable objects using a generator.

Parameters:
  • table_locator – locator pointing to a table element with child thead and tbody elements representing that table’s header and body row containers
  • header_offset – In the case of a padding table row above the header, the row offset can be used to skip rows in <thead> to locate the correct header row. This offset is 1-indexed, not 0-indexed, so an offset of 1 is the first child row element
  • body_offset – In the case of a padding table row above the body rows, the row offset can be used to skip rows in <ttbody> to locate the correct header row. This offset is 1-indexed, not 0-indexed, so an offset of 1 is the first child row element
  • hidden_locator – If the table can disappear, you probably want ot set this param as it instructs the table that if it cannot find the table on the page but the element represented by hidden_locator is visible, it assumes no data and returns no rows.
header_indexes

A dict of header names related to their int index as a column.

Usage:

table = Table('//div[@id="prov_pxe_img_div"]//table')

The HTML code for the table looks something like this:

<div id="prov_pxe_img_div">
  <table>
      <thead>
          <tr>
              <th>Name</th>
              <th>Animal</th>
              <th>Size</th>
          </tr>
      </thead>
      <tbody>
          <tr>
              <td>John</td>
              <td>Monkey</td>
              <td>Small</td>
          </tr>
          <tr>
              <td>Mike</td>
              <td>Tiger</td>
              <td>Large</td>
          </tr>
      </tbody>
  </table>
</div>

We can now click on an element in the list like so, by providing the column name and the value that we are searching for:

table.click_cell('name', 'Mike')

We can also perform the same, by using the index of the column, like so:

table.click_cell(1, 'Tiger')

Additionally, the rows of a table can be iterated over, and that row’s columns can be accessed by name or index (left to right, 0-index):

for row in table.rows()
    # Get the first cell in the row
    row[0]
    # Get the row's contents for the column with header 'Row Name'
    # All of these will work, though the first is preferred
    row.row_name, row['row_name'], row['Row Name']

When doing bulk opererations, such as selecting rows in a table based on their content, the *_by_cells methods are able to find matching row much more quickly than iterating, as the work can be done with fewer selenium calls.

Note

A table is defined by the containers of the header and data areas, and offsets to them. This allows a table to include one or more padding rows above the header row. In the example above, there is no padding row, as our offset values are set to 0.

class Row(row_element, parent_table)[source]

Bases: utils.pretty.Pretty

An object representing a row in a Table.

The Row object returns a dymanically addressable attribute space so that the tables headers are automatically generated.

Parameters:
  • row_element – A table row WebElement
  • parent_table – Table containing row_element

Notes

Attributes are dynamically generated. The index/key accessor is more flexible than the attr accessor, as it can operate on int indices and header names.

__getattr__(name)[source]

Returns Row element by header name

__getitem__(index)[source]

Returns Row element by header index or name

columns

A list of WebElements corresponding to the <td> elements in this row

locate()[source]
pretty_attrs = ['row_element', 'table']
Table.body

Property representing the <tbody> element that contains body rows

Table.click_cell(header, value)[source]

Clicks on a cell defined in the row.

Uses the header identifier and a value to determine which cell to click on.

Parameters:
  • header – A string or int, describing which column to inspect.
  • value – The value to be compared when trying to identify the correct cell to click the cell in.

Returns: True if item was found and clicked, else False.

Table.click_cells(cell_map)[source]

Submits multiple cells to be clicked on

Parameters:cell_map –

A mapping of header names and values, representing cells to click. As an example, {'name': ['wing', 'nut']}, {'age': ['12']} would click on the cells which had wing and nut in the name column and 12 in the age column. The yaml example for this would be as follows:

list_items:
    name:
        - wing
        - nut
    age:
        - 12
Raises:NotAllItemsClicked – If some cells were unable to be found.
Table.click_row_by_cells(cells, click_column=None, partial_check=False)[source]

Click the cell at click_column in the first row matched by cells

Parameters:
Table.click_rows_by_cells(cells, click_column=None, partial_check=False)[source]

Click the cell at click_column in the rows matched by cells

Parameters:
  • cells – See Table.find_rows_by_cells()
  • click_column – Which column in the row to click, defaults to None, which will attempt to click the row element

Note

The value of click_column can be a string or an int, and will be passed directly to the item accessor (__getitem__) for Table.Row

Table.create_row_from_element(row_element)[source]

Given a row element in this table, create a Table.Row

Parameters:row_element – A table row (<tr>) WebElement representing a row in this table.

Returns: A Table.Row for row_element

Table.find_cell(header, value)[source]

Finds an item in the Table by iterating through each visible item, this work used to be done by the :py:meth::click_cell method but has not been abstracted out to be called separately.

Parameters:
  • header – A string or int, describing which column to inspect.
  • value – The value to be compared when trying to identify the correct cell to click.

Returns: WebElement of the element if item was found, else None.

Table.find_row(header, value)[source]

Finds a row in the Table by iterating through each visible item.

Parameters:
  • header – A string or int, describing which column to inspect.
  • value – The value to be compared when trying to identify the correct row to return.
Returns:

Table.Row containing the requested cell, else None.
Table.find_row_by_cells(cells, partial_check=False)[source]

Find the first row containing cells

Parameters:cells – See Table.find_rows_by_cells()

Returns: The first matching row found, or None if no matching row was found

Table.find_rows_by_cells(cells, partial_check=False)[source]

A fast row finder, based on cell content.

If you pass a regexp as a value, then it will be used with its .match() method.

Parameters:
  • cells – A dict of header: value pairs or a sequence of nested (header, value) pairs.
  • partial_check – If to use the in operator rather than ==.
Returns: A list of containing Table.Row objects whose contents
match all of the header: value pairs in cells
Table.header_indexes

Dictionary of header name: column index for this table’s rows

Derived from headers

Table.header_row

Property representing the <tr> element that contains header cells

Table.headers

List of <td> or <th> elements in header_row

Table.locate()[source]
Table.pretty_attrs = ['_loc']
Table.row_count()[source]

Returns row count

Table.rows()[source]

A generator method holding the Row objects

This generator yields Row objects starting at the first data row.

Yields:Table.Row object corresponding to the next row in the table.
Table.rows_as_list()[source]

Returns rows as list

Table.verify_headers()[source]

Verifies whether the headers in the table correspond with the cached ones.

class cfme.web_ui.Tree(locator)[source]

Bases: utils.pretty.Pretty

A class directed at CFME Tree elements

The Tree class aims to deal with all kinds of CFME trees

Parameters:locator – This is a locator object pointing to the <ul> element which contains the rest of the table.

Returns: A Tree object.

A Tree object is set up by using a locator which contains the node elements. This element will usually be a <ul> in the case of a Dynatree.

Usage:

tree = web_ui.Tree((By.XPATH, '//table//tr[@title="Datastore"]/../..'))

The path can then be navigated to return the last object in the path list, like so:

tree.click_path('Automation', 'VM Lifecycle Management (VMLifecycle)',
    'VM Migrate (Migrate)')

Each path element will be expanded along the way, but will not be clicked.

When used in a Form, a list of path tuples is expected in the form fill data. The paths will be passed individually to Tree.check_node():

form = Form(fields=[
    ('tree_field', List(locator)),
])

form_fill_data = {
    'tree_field': [
        ('Tree Node', 'Value'),
        ('Tree Node', 'Branch Node', 'Value'),
    ]
]

Note: Dynatrees, rely on a <ul><li> setup. We class a <li> as a node.

classmethod browse(tree, *path)[source]

Browse through tree via path.

If node not found, raises exception. If the browsing reached leaf(str), returns True if also the step was last, otherwise False. If the result of the path is a subtree, it is returned.

Parameters:
  • tree – List with tree.
  • *path – Path to browse.
click_path(*path, **kwargs)[source]

Exposes a path and then clicks it.

Parameters:*path – The path as multiple positional string arguments denoting the course to take.
Keywords:
by_id: Whether to match ids instead of text.

Returns: The leaf web element.

expand_path(*path, **kwargs)[source]

Exposes a path.

Parameters:*path – The path as multiple positional string arguments denoting the course to take.
Keywords:
by_id: Whether to match ids instead of text.

Returns: The leaf web element.

find_path_to(target, exact=False)[source]

Method used to look up the exact path to an item we know only by its regexp or partial description.

Expands whole tree during the execution.

Parameters:
  • target – Item searched for. Can be regexp made by re.compile, otherwise it is taken as a string for in matching.
  • exact – Useful in string matching. If set to True, it matches the exact string. Default is False.

Returns: list with path to that item.

classmethod flatten_level(tree)[source]

Extracts just node names from current tree (top).

It makes:

["asd", "fgh", ("ijk", [...]), ("lmn", [...])]

to

["asd", "fgh", "ijk", "lmn"]

Useful for checking of contents of current tree level

locate()[source]
pretty_attrs = ['locator']
read_contents(by_id=False)[source]
root_el()[source]
tree_id
class cfme.web_ui.UpDownSelect(select_loc, up_loc, down_loc)[source]

Bases: cfme.web_ui.Region

Multiselect with two arrows (up/down) next to it. Eg. in AE/Domain priority selection.

Parameters:
  • select_loc – Locator for the select box (without Select element wrapping)
  • up_loc – Locator of the Move Up arrow.
  • down_loc – Locator with Move Down arrow.
get_items()[source]
move_bottom(item)[source]
move_down(item)[source]
move_top(item)[source]
move_up(item)[source]
cfme.web_ui.breadcrumbs()[source]

Returns a list of breadcrumbs names if names==True else return as elements.

Returns:list of breadcrumbs if they are present, NoneType otherwise.
cfme.web_ui.breadcrumbs_names()[source]
cfme.web_ui.browser_title()[source]

Returns a title of the page.

Returns:str if present, NoneType otherwise.
cfme.web_ui.controller_name()[source]

Returns a title of the page.

Returns:str if present, NoneType otherwise.
cfme.web_ui.fill_bootstrap_switch(bs, val)[source]
cfme.web_ui.fill_callable(f, val)[source]

Fill in a Callable by just calling it with the value, allow for arbitrary actions

cfme.web_ui.fill_cb_select_bool(select, all_state)[source]
cfme.web_ui.fill_cb_select_dictlist(select, dictlist)[source]
cfme.web_ui.fill_cb_select_set(select, names)[source]
cfme.web_ui.fill_cb_select_string(select, cb)[source]
cfme.web_ui.fill_cfmecheckbox_switch(ob, val)[source]
cfme.web_ui.fill_checkbox(cb, val)[source]
cfme.web_ui.fill_click(el, val)[source]

Click only when given a truthy value

cfme.web_ui.fill_email_select_form(form, emails)[source]
cfme.web_ui.fill_file(fd, val)[source]
cfme.web_ui.fill_multiselect(ms, items)[source]
cfme.web_ui.fill_number(bmbox, val)[source]
cfme.web_ui.fill_oldcheckbox_switch(ob, val)[source]
cfme.web_ui.fill_password(pwbox, password)[source]
cfme.web_ui.fill_scriptbox(sb, script)[source]

This function now clears and sets the ScriptBox.

cfme.web_ui.fill_select(slist, val)[source]
cfme.web_ui.fill_select_tag(select, value)[source]
cfme.web_ui.fill_text(textbox, val)[source]
cfme.web_ui.get_context_current_page()[source]

Returns the current page name

Returns: A string containing the current page name

cfme.web_ui.match_location(controller=None, title=None, summary=None)[source]

Does exact match of passed data

Returns: bool

cfme.web_ui.select_dhtml(dhtml, s)[source]
cfme.web_ui.select_multiselect(ms, values)[source]
cfme.web_ui.summary_title()[source]

Returns a title of the page.

Returns:str if present, NoneType otherwise.
cfme.web_ui.table_in_object(table_title)[source]

If you want to point to tables inside object view, this is what you want to use.

Works both on down- and upstream.

Parameters:table_title – Text in p element preceeding the table

Returns: XPath locator for the desired table.

Submodules

cfme.dashboard module
class cfme.dashboard.Dashboard(name, collection=None, appliance=None)[source]

Bases: utils.appliance.Navigatable

dashboard_view

Returns a view pointed at a particular dashboard.

drag_and_drop(dragged_widget_or_name, dropped_widget_or_name)[source]

Drags and drops widgets onto each other.

widgets
class cfme.dashboard.DashboardCollection(*args, **kwargs)[source]

Bases: utils.appliance.Navigatable

Represents the Dashboard page and can jump around various dashboards present.

all()[source]
close_zoom()[source]

Closes any zoomed widget.

default

Returns an instance of the Default Dashboard

instantiate(name)[source]
refresh()[source]

Refreshes the dashboard view by forcibly clicking the navigation again.

zoomed_name

Grabs the name of the currently zoomed widget.

class cfme.dashboard.DashboardDetails(obj, navigate_obj)[source]

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ParticularDashboardView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.dashboard.DashboardView(parent, logger=None, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

View that represents the Intelligence/Dashboard.

add_widget

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

dashboards

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ensure_zoom_closed()[source]
is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_widgets(cancel=False)[source]

Clicks the reset button to reset widgets and handles the alert.

zoomed

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.dashboard.DashboardWidget(name, widget_collection)[source]

Bases: utils.appliance.Navigatable

Represents a single UI dashboard widget.

Parameters:
  • name – Name of the widget as displayed in the title.
  • widget_collection – The widget collection linked to a dashboard
blank

Returns whether the widget has not been generated before.

can_zoom

Returns whether this widget can be zoomed.

close_zoom()[source]

Close zoom. Works theoretically for any widget, it is just exposed here.

content_type

Returns the type of content of this widget

contents

Returns the WT widget with contents of this dashboard widget.

dashboard
footer

Return parsed footer value

is_zoomed

Returns whether this widget is zoomed now.

last_in_column

Returns whether this widget is the last in its column

minimize()[source]

Minimize this widget.

minimized

Returns whether the widget is minimized or not.

remove()[source]

Remove this widget.

restore()[source]

Maximize this widget.

time_next

Returns a datetime when the widget will be updated.

time_updated

Returns a datetime when the widget was last updated.

widget_view

Returns a view of the particular widget.

zoom()[source]

Zoom this widget in.

class cfme.dashboard.DashboardWidgetCollection(dashboard)[source]

Bases: utils.appliance.Navigatable

all(content_type=None)[source]
dashboard_view
instantiate(name)[source]
reset(cancel=False)[source]

Clicks the Reset widgets button.

class cfme.dashboard.Kebab(parent, button_id=None, logger=None)[source]

Bases: widgetastic.widget.Widget

The so-called “kebab” widget of Patternfly.

<http://www.patternfly.org/pattern-library/widgets/#kebabs>

Parameters:button_id – id of the button tag inside the kebab. If not specified, first kebab available will be used
BUTTON = './button'
ITEM = './ul/li/a[normalize-space(.)={}]'
ITEMS = './ul/li/a'
ROOT
UL = './ul[contains(@class, "dropdown-menu")]'
close()[source]

Close the kebab

is_opened

Returns opened state of the kebab.

items

Lists all items in the kebab.

Returns:list of str
open()[source]

Open the kebab

select(item, close=True)[source]

Select a specific item from the kebab.

Parameters:
  • item – Item to be selected.
  • close – Whether to close the kebab after selection. If the item is a link, you may want to set this to False
class cfme.dashboard.ParticularDashboardView(parent, logger=None, **kwargs)[source]

Bases: cfme.dashboard.DashboardView

is_displayed
cfme.exceptions module

Provides custom exceptions for the cfme module.

exception cfme.exceptions.AccordionItemNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised when it’s not possible to locate and accordion item.

exception cfme.exceptions.AddProviderError[source]

Bases: cfme.exceptions.CFMEException

exception cfme.exceptions.AuthModeUnknown[source]

Bases: cfme.exceptions.CFMEException

Raised if an invalid authenctication mode is passed to cfme.configure.configuration.set_auth_mode()

exception cfme.exceptions.AutomateImportError[source]

Bases: cfme.exceptions.CFMEException

Raised by scripts dealing with Automate when importing automate XML fails

exception cfme.exceptions.AvailabilityZoneNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific Cloud Availability Zone cannot be found.

exception cfme.exceptions.BlockTypeUnknown[source]

Bases: cfme.exceptions.CFMEException

Raised if the block type requested to cfme.web_ui.InfoBlock.

exception cfme.exceptions.CFMEException[source]

Bases: exceptions.Exception

Base class for exceptions in the CFME tree

Used to easily catch errors of our own making, versus errors from external libraries.

exception cfme.exceptions.CFMEExceptionOccured[source]

Bases: cfme.exceptions.CFMEException

Raised by cfme.web_ui.cfme_exception.assert_no_cfme_exception() when there is a Rails exception currently on page.

exception cfme.exceptions.CUCommandException[source]

Bases: cfme.exceptions.CFMEException

Raised when one of the commands run to set up a CU VM fails

exception cfme.exceptions.CandidateNotFound(d)[source]

Bases: cfme.exceptions.CFMEException

Raised if there is no candidate found whilst trying to traverse a tree in cfme.web_ui.Tree.click_path().

message
exception cfme.exceptions.CannotContinueWithNavigation[source]

Bases: cfme.exceptions.CFMEException

Used when it is not possible to continue with navigation.

Raising it will recycle the browser, therefore refresh the session. If you pass a string to the constructor, it will be written to the log.

exception cfme.exceptions.CannotScrollException[source]

Bases: cfme.exceptions.CFMEException

Raised when even during the heaviest workarounds for scrolling failure comes.

exception cfme.exceptions.ClusterNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a cluster is not found

exception cfme.exceptions.ConsoleNotSupported(product_name, version)[source]

Bases: cfme.exceptions.CFMEException

Raised by functions in cfme.configure.configuration when an invalid console type is given

exception cfme.exceptions.ConsoleTypeNotSupported(console_type)[source]

Bases: cfme.exceptions.CFMEException

Raised by functions in cfme.configure.configuration when an invalid console type is given

exception cfme.exceptions.DbAllocatorConfigNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised when cdme_data.yaml file does not contain configuration of ‘db_allocator’.

exception cfme.exceptions.DestinationNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised during navigation where the navigator destination is not found

exception cfme.exceptions.ElementOrBlockNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if an Element or a Block is not found whilst locating in cfme.web_ui.InfoBlock().

exception cfme.exceptions.FlashMessageException[source]

Bases: cfme.exceptions.CFMEException

Raised by functions in cfme.web_ui.flash

skip_and_log(message='Skipping due to flash message')[source]
exception cfme.exceptions.FlavorNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific cloud flavor cannot be found in the UI

exception cfme.exceptions.HostNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific host cannot be found in UI.

exception cfme.exceptions.HostStatsNotContains[source]

Bases: cfme.exceptions.CFMEException

Raised if the hosts information does not contain the specified key whilst running cfme.cloud.provider.Provider.do_stats_match().

exception cfme.exceptions.ImageNotFound[source]

Bases: cfme.exceptions.VmOrInstanceNotFound

Raised if a specific image cannot be found

exception cfme.exceptions.InstanceNotFound[source]

Bases: cfme.exceptions.VmOrInstanceNotFound

Raised if a specific instance cannot be found.

exception cfme.exceptions.ItemNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised when an item is not found in general.

exception cfme.exceptions.JDBCDriverConfigNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised when cdme_data.yaml file does not contain configuration of ‘jdbc_drivers’.

exception cfme.exceptions.KeyPairNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific cloud key pair cannot be found in the UI

exception cfme.exceptions.LabelNotFoundException[source]

Bases: exceptions.Exception

Raises when failed to remove label from object via cli

exception cfme.exceptions.ListAccordionLinkNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised when active link containing specific text could not be found in expended cfme.web_ui.listaccordion content section.

exception cfme.exceptions.ManyEntitiesFound[source]

Bases: cfme.exceptions.CFMEException

Raised when one or no items were expected but several/many items were obtained instead.

exception cfme.exceptions.MenuItemNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised during navigation of certain menu item was not found.

exception cfme.exceptions.MiddlewareDomainNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific Middleware Domain cannot be found.

exception cfme.exceptions.MiddlewareServerGroupNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific Middleware Server Group cannot be found.

exception cfme.exceptions.MiddlewareServerNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific Middleware Server cannot be found.

exception cfme.exceptions.NavigationError(page_name)[source]

Bases: cfme.exceptions.CFMEException

Raised when the pytest.sel.go_to function is unable to navigate to the requested page.

exception cfme.exceptions.NoElementsInsideValue[source]

Bases: cfme.exceptions.CFMEException

Raised if the value part of key/value contains no elements during cfme.web_ui.InfoBlock.get_el_or_els().

exception cfme.exceptions.NodeNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific container node cannot be found in the UI

exception cfme.exceptions.NotAllCheckboxesFound(failed_selects)[source]

Bases: cfme.exceptions.CFMEException

Raised if not all the checkboxes could be found during e.g. cfme.web_ui.CheckboxTable.select_rows() and other methods of this class.

exception cfme.exceptions.NotAllItemsClicked(failed_clicks)[source]

Bases: cfme.exceptions.CFMEException

Raised if not all the items could be clicked during cfme.web_ui.Table.click_cell().

exception cfme.exceptions.OptionNotAvailable[source]

Bases: cfme.exceptions.CFMEException

Raised if a specified option is not available.

exception cfme.exceptions.PaginatorException[source]

Bases: cfme.exceptions.CFMEException

Raised by functions in cfme.web_ui.paginator

exception cfme.exceptions.ProviderHasNoKey[source]

Bases: cfme.exceptions.CFMEException

Raised if the cfme.cloud.provider.Provider.get_mgmt_system() method is called but the Provider instance has no key.

exception cfme.exceptions.ProviderHasNoProperty[source]

Bases: cfme.exceptions.CFMEException

Raised if the provider does not have the property requested whilst running cfme.cloud.provider.Provider.do_stats_match().

exception cfme.exceptions.RequestException[source]

Bases: cfme.exceptions.CFMEException

Raised if a request was not found or multiple rows matched during _request functions in cfme.services.requests

exception cfme.exceptions.ResourcePoolNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific cloud key pair cannot be found in the UI

exception cfme.exceptions.RoleNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised when Deployment role not found

exception cfme.exceptions.ScheduleNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a schedule was not found in cfme.configure.configuration.Schedule.delete_by_name()

exception cfme.exceptions.StackNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific stack cannot be found.

exception cfme.exceptions.StorageManagerNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised when a Storage Manager is not found

exception cfme.exceptions.TemplateNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific Template cannot be found.

exception cfme.exceptions.TenantNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific tenant cannot be found

exception cfme.exceptions.ToolbarOptionGreyedOrUnavailable[source]

Bases: cfme.exceptions.CFMEException

Raised when toolbar wants to click item that is greyed or unavailable

exception cfme.exceptions.TreeNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if the tree used for cfme.web_ui.Tree.expand_path() cannot be found

exception cfme.exceptions.TreeTypeUnknown[source]

Bases: cfme.exceptions.CFMEException

Raised if the tree type is known whilst detection in cfme.web_ui.Tree

exception cfme.exceptions.UnidentifiableTagType[source]

Bases: cfme.exceptions.CFMEException

Raised if a tag type is not identifiable when processing a form in cfme.web_ui.Form.fill_fields().

exception cfme.exceptions.UnknownProviderType[source]

Bases: cfme.exceptions.CFMEException

Raised when the passed provider or provider type is not known or usable in given context e.g. when getting a provider from yaml and the provider type doesn’t match any of known types or when an infra provider is passed to the cloud’s instance_factory method

exception cfme.exceptions.UsingSharedTables[source]

Bases: cfme.exceptions.CFMEException

Raised if the cfme.web_ui.Table suspects there is a use of shared tables.

exception cfme.exceptions.VmNotFound[source]

Bases: cfme.exceptions.VmOrInstanceNotFound

Raised if a specific VM cannot be found.

exception cfme.exceptions.VmNotFoundViaIP[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific VM cannot be found.

exception cfme.exceptions.VmOrInstanceNotFound[source]

Bases: cfme.exceptions.CFMEException

exception cfme.exceptions.VolumeNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised if a specific cloud volume cannot be found in the UI

exception cfme.exceptions.ZoneNotFound[source]

Bases: cfme.exceptions.CFMEException

Raised when a specific Zone cannot be found in the method cfme.configure.configuration.

cfme.js module
cfme.provisioning module
cfme.provisioning.do_vm_provisioning(template_name, provider, vm_name, provisioning_data, request, smtp_test, num_sec=1500, wait=True)[source]
cfme.provisioning.select_security_group(sg)[source]

TODO: Not even sure this is needed any more, but removal of it is not part of this PR

cfme.roles module
cfme.test_requirements module

Test requirements mapping

This module contains predefined pytest markers for CFME product requirements.

Please import the module instead of elements:

from cfme import test_requirements

pytestmark = [test_requirements.alert]

@test_requirments.quota
def test_quota_alert():
    pass

Module contents

fixtures package

Subpackages

fixtures.parallelizer package
Submodules
fixtures.parallelizer.hooks module

parallelizer hooks

Custom hooks to help keep runtime ordering straight with regard to the parallelizer’s state

fixtures.parallelizer.hooks.pytest_parallel_configured(parallel_session)[source]

called after the parallel session is configured

This is always called, whether running parallel or not.

If running standalone, parallel_session will be None.

fixtures.parallelizer.parallelizer_tester module

parallelizer tester

Useful to make sure tests are being parallelized properly, and then reported correctly.

This file is named specially to prevent being picked up by py.test’s default collector, and should not be run during a normal test run.

fixtures.parallelizer.parallelizer_tester.setup_fail()[source]
fixtures.parallelizer.parallelizer_tester.teardown_fail()[source]
fixtures.parallelizer.parallelizer_tester.test_fails()[source]
fixtures.parallelizer.parallelizer_tester.test_fails_setup(setup_fail)[source]
fixtures.parallelizer.parallelizer_tester.test_fails_teardown(teardown_fail)[source]
fixtures.parallelizer.parallelizer_tester.test_passes()[source]
fixtures.parallelizer.parallelizer_tester.test_skipped()[source]
fixtures.parallelizer.parallelizer_tester.test_xfails()[source]
fixtures.parallelizer.parallelizer_tester.test_xpasses()[source]
fixtures.parallelizer.parallelizer_tester.the_param()[source]
fixtures.parallelizer.parallelizer_tester.wait()[source]
fixtures.parallelizer.remote module
class fixtures.parallelizer.remote.SlaveManager(config, slaveid, base_url, zmq_endpoint)[source]

Bases: object

SlaveManager which coordinates with the master process for parallel testing

handle_quit()[source]
message(message, **kwargs)[source]

Send a message to the master, which should get printed to the console

pytest_collection_finish(session)[source]

pytest collection hook

  • Sends collected tests to the master for comparison
pytest_internalerror(excrepr)[source]

pytest internal error hook

  • logs full traceback
  • reports short traceback to the py.test console
pytest_runtest_logreport(report)[source]

pytest runtest logreport hook

  • sends serialized log reports to the master
pytest_runtest_logstart(nodeid, location)[source]

pytest runtest logstart hook

  • sends logstart notice to the master
pytest_runtestloop(session)[source]

pytest runtest loop

  • iterates over and runs tests in the order received from the master
pytest_sessionfinish()[source]
send_event(name, **kwargs)[source]
shutdown()[source]
fixtures.parallelizer.remote.serialize_report(rep)[source]

Get a TestReport ready to send to the master

Module contents

Parallel testing, supporting arbitrary collection ordering

The Workflow
  • Master py.test process starts up, inspects config to decide how many slave to start, if at all
    • env[‘parallel_base_urls’] is inspected first
    • py.test config.option.appliances and the related –appliance cmdline flag are used if env[‘parallel_base_urls’] isn’t set
    • if neither are set, no parallelization happens
  • Slaves are started
  • Master runs collection, blocks until slaves report their collections
  • Slaves each run collection and submit them to the master, then block inside their runtest loop, waiting for tests to run
  • Master diffs slave collections against its own; the test ids are verified to match across all nodes
  • Master enters main runtest loop, uses a generator to build lists of test groups which are then sent to slaves, one group at a time
  • For each phase of each test, the slave serializes test reports, which are then unserialized on the master and handed to the normal pytest reporting hooks, which is able to deal with test reports arriving out of order
  • Before running the last test in a group, the slave will request more tests from the master
    • If more tests are received, they are run
    • If no tests are received, the slave will shut down after running its final test
  • After all slaves are shut down, the master will do its end-of-session reporting as usual, and shut down
class fixtures.parallelizer.Outcome(word, markup)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

markup

Alias for field number 1

word

Alias for field number 0

class fixtures.parallelizer.ParallelSession(config, appliances)[source]

Bases: object

ack(slave, event_name)[source]

Acknowledge a slave’s message

get(slave)[source]
interrupt(slave, **kwargs)[source]

Nicely ask a slave to terminate

kill(slave, **kwargs)[source]

Rudely kill a slave

monitor_shutdown(slave)[source]
print_message(message, prefix='master', **markup)[source]

Print a message from a node to the py.test console

Parameters:
  • message – The message to print
  • **markup – If set, overrides the default markup when printing the message
pytest_runtestloop()[source]

pytest runtest loop

  • Disable the master terminal reporter hooks, so we can add our own handlers that include the slaveid in the output
  • Send tests to slaves when they ask
  • Log the starting of tests and test results, including slave id
  • Handle clean slave shutdown when they finish their runtest loops
  • Restore the master terminal reporter after testing so we get the final report
pytest_sessionstart(session)[source]

pytest sessionstart hook

  • sets up distributed terminal reporter
  • sets up zmp ipc socket for the slaves to use
  • writes pytest options and args to slave_config.yaml
  • starts the slaves
  • register atexit kill hooks to destroy slaves at the end if things go terribly wrong
recv()[source]
send(slave, event_data)[source]

Send data to slave.

event_data will be serialized as JSON, and so must be JSON serializable

send_tests(slave)[source]

Send a slave a group of tests

class fixtures.parallelizer.SlaveDetail(appliance, id=NOTHING, tests=NOTHING, process=None, provider_allocation=NOTHING)[source]

Bases: object

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

appliance = Attribute(name='appliance', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
forbid_restart = Attribute(name='forbid_restart', default=False, validator=None, repr=True, cmp=True, hash=None, init=False, convert=None, metadata=mappingproxy({}))
id = Attribute(name='id', default=Factory(factory=<function <lambda> at 0x7f0489dba9b0>, takes_self=False), validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
poll()[source]
process = Attribute(name='process', default=None, validator=None, repr=False, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
provider_allocation = Attribute(name='provider_allocation', default=Factory(factory=<type 'list'>, takes_self=False), validator=None, repr=False, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
slaveid_generator = <generator object <genexpr>>
start()[source]
tests = Attribute(name='tests', default=Factory(factory=<type 'set'>, takes_self=False), validator=None, repr=False, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
class fixtures.parallelizer.TerminalDistReporter(config, terminal)[source]

Bases: object

Terminal Reporter for Distributed Testing

trdist reporter exists to make sure we get good distributed logging during the runtest loop, which means the normal terminal reporter should be disabled during the loop

This class is where we make sure the terminal reporter is made aware of whatever state it needs to report properly once we turn it back on after the runtest loop

It has special versions of pytest reporting hooks that, where possible, try to include a slave ID. These hooks are called in ParallelSession‘s runtestloop hook.

runtest_logreport(slaveid, report)[source]
runtest_logstart(slaveid, nodeid, location)[source]
fixtures.parallelizer.handle_end_session(signal, frame)[source]
fixtures.parallelizer.pytest_addhooks(pluginmanager)[source]
fixtures.parallelizer.pytest_configure(config)[source]

Configures the parallel session, then fires pytest_parallel_configured.

fixtures.parallelizer.report_collection_diff(slaveid, from_collection, to_collection)[source]

Report differences, if any exist, between master and a slave collection

Raises RuntimeError if collections differ

Note

This function will sort functions before comparing them.

fixtures.parallelizer.unserialize_report(reportdict)[source]

Generate a TestReport from a serialized report

Submodules

fixtures.appliance module

This module contains fixtures to use when you need a temporary appliance for testing.

In cases where you cannot run a certain test againts the primary appliance because of the test’s destructive potential (which could render all subsequent testing useless), you want to use a temporary appliance parallel to the primary one.

For tests where all you need is a single preconfigured appliance to run a database restore on for example, you will want to use the temp_appliance_preconfig() fixture.

For tests that require multiple unconfigured appliances (e.g. replication testing), there is temp_appliances_unconfig().

fixtures.appliance.temp_appliance_preconfig(temp_appliance_preconfig_modscope)[source]
fixtures.appliance.temp_appliance_preconfig_clsscope()[source]
fixtures.appliance.temp_appliance_preconfig_funcscope()[source]
fixtures.appliance.temp_appliance_preconfig_funcscope_upgrade(appliance)[source]
fixtures.appliance.temp_appliance_preconfig_modscope()[source]
fixtures.appliance.temp_appliance_unconfig(temp_appliance_unconfig_modscope)[source]
fixtures.appliance.temp_appliance_unconfig_clsscope()[source]
fixtures.appliance.temp_appliance_unconfig_funcscope()[source]
fixtures.appliance.temp_appliance_unconfig_modscope()[source]
fixtures.appliance.temp_appliances(*args, **kwds)[source]

Provisions one or more appliances for testing

Parameters:
  • count – Number of appliances
  • preconfigured – True if the appliance should be already configured, False otherwise
  • lease_time – Lease time in minutes (3 hours by default)
fixtures.appliance.temp_appliances_unconfig(temp_appliances_unconfig_modscope)[source]
fixtures.appliance.temp_appliances_unconfig_clsscope()[source]
fixtures.appliance.temp_appliances_unconfig_funcscope()[source]
fixtures.appliance.temp_appliances_unconfig_modscope()[source]
fixtures.appliance_update module

This module allows you to update an appliance with latest RHEL.

It has two uses: 1) If only --update-appliance is specified, it will use the YAML url. 2) If you also specify one or more --update-url, it will use them instead.

fixtures.appliance_update.pytest_addoption(parser)[source]
fixtures.appliance_update.pytest_sessionstart(session)[source]
fixtures.artifactor_plugin module

An example config:

artifactor:
    log_dir: /home/test/workspace/cfme_tests/artiout
    per_run: test #test, run, None
    reuse_dir: True
    squash_exceptions: False
    threaded: False
    server_address: 127.0.0.1
    server_port: 21212
    server_enabled: True
    plugins:

log_dir is the destination for all artifacts

per_run denotes if the test artifacts should be group by run, test, or None

reuse_dir if this is False and Artifactor comes across a dir that has already been used, it will die

class fixtures.artifactor_plugin.DummyClient[source]

Bases: object

fire_hook(*args, **kwargs)[source]
task_status()[source]
terminate()[source]
fixtures.artifactor_plugin.fire_art_hook(config, hook, **hook_args)[source]
fixtures.artifactor_plugin.fire_art_test_hook(node, hook, **hook_args)[source]
fixtures.artifactor_plugin.get_client(art_config, pytest_config)[source]
fixtures.artifactor_plugin.get_name(obj)[source]
fixtures.artifactor_plugin.get_test_idents(item)[source]
fixtures.artifactor_plugin.pytest_addoption(parser)[source]
fixtures.artifactor_plugin.pytest_configure(config)[source]
fixtures.artifactor_plugin.pytest_runtest_logreport(report)[source]
fixtures.artifactor_plugin.pytest_runtest_protocol(item)[source]
fixtures.artifactor_plugin.pytest_runtest_teardown(item, nextitem)[source]
fixtures.artifactor_plugin.pytest_unconfigure(config)[source]
fixtures.artifactor_plugin.shutdown(config)[source]
fixtures.artifactor_plugin.spawn_server(config, art_client)[source]
fixtures.blockers module

Collection of fixtures for simplified work with blockers.

You can use the blocker() fixture to retrieve any blocker using blocker syntax (as described in cfme.metaplugins.blockers). The bug() fixture is specific for bugzilla, it accepts number argument and spits out the BUGZILLA BUG! (a utils.bz.BugWrapper, not a utils.blockers.BZ!). The blockers() retrieves list of all blockers as specified in the meta marker. All of them are converted to the utils.blockers.Blocker instances

fixtures.blockers.blocker(uses_blockers)[source]

Return any blocker that matches the expression.

Returns:Instance of utils.blockers.Blocker
fixtures.blockers.blockers(uses_blockers, meta)[source]

Returns list of all assigned blockers.

Returns:List of utils.blockers.Blocker instances.
fixtures.blockers.bug(blocker)[source]

Return bugzilla bug by its id.

Returns:Instance of utils.bz.BugWrapper or NoneType if the bug is closed.
fixtures.blockers.pytest_addoption(parser)[source]
fixtures.blockers.pytest_collection_modifyitems(session, config, items)[source]
fixtures.browser module
fixtures.browser.browser()[source]
fixtures.browser.nuke_browser_after_test()[source]

Some more disruptive tests have to take this measure.

fixtures.browser.pytest_exception_interact(node, call, report)[source]
fixtures.browser.pytest_namespace()[source]
fixtures.browser.pytest_runtest_setup(item)[source]
fixtures.browser.pytest_sessionfinish(session, exitstatus)[source]
fixtures.cfme_data module
fixtures.cfme_data.cfme_data(request)[source]
fixtures.datafile module
fixtures.datafile.datafile(filename, replacements)[source]

datafile fixture, with templating support

Parameters:
  • filename – filename to load from the data dir
  • replacements – template replacements

Returns: Path to the loaded datafile

Usage:

Given a filename, it will attempt to open the given file from the
test's corresponding data dir. For example, this:

    datafile('testfile') # in tests/subdir/test_module_name.py

Would return a file object representing this file:

    /path/to/cfme_tests/data/subdir/test_module_name/testfile

Given a filename with a leading slash, it will attempt to load the file
relative to the root of the data dir. For example, this:

    datafile('/common/testfile') # in tests/subdir/test_module_name.py

Would return a file object representing this file:

    /path/to/cfme_tests/data/common/testfile

Note that the test module name is not used with the leading slash.

Templates:

This fixture can also handle template replacements. If the datafile being loaded is a python template, the dictionary of replacements can be passed as the ‘replacements’ keyword argument. In this case, the returned data file will be a NamedTemporaryFile prepopulated with the interpolated result from combining the template with the replacements mapping.

fixtures.datafile.pytest_addoption(parser)[source]
fixtures.datafile.pytest_sessionfinish(session, exitstatus)[source]
fixtures.dev_branch module
fixtures.dev_branch.pytest_addoption(parser)[source]
fixtures.dev_branch.pytest_sessionstart(session)[source]
fixtures.disable_forgery_protection module
fixtures.disable_forgery_protection.disable_forgery_protection()[source]
fixtures.events module

Event testing fixture.

The idea of this fixture is to pass some “expected” events to utils.events.EventListener and check whether all expected events are received at the test end.

register_event fixture accepts attributes for one expected event

simple example:

register_event(target_type='VmOrTemplate', target_name=vm_crud.name, event_type='vm_create')

more complex example:

def add_cmp(_, y):
    data = yaml.load(y)
    return data['resourceId'].endswith(nsg_name) and data['status']['value'] == 'Accepted' and             data['subStatus']['value'] == 'Created'

fd_add_attr = {'full_data': 'will be ignored',
               'cmp_func': add_cmp}

# add network security group event
register_event(fd_add_attr, source='AZURE',
               event_type='networkSecurityGroups_write_EndRequest')

def rm_cmp(_, y):
    data = yaml.load(y)
    return data['resourceId'].endswith(nsg_name) and data['status']['value'] == 'Succeeded'             and len(data['subStatus']['value']) == 0

fd_rm_attr = {'full_data': 'will be ignored',
              'cmp_func': rm_cmp}

# remove network security group event
register_event(fd_rm_attr, source=provider.type.upper(),
               event_type='networkSecurityGroups_delete_EndRequest')

Expected events are defined by set of event attributes which should match to the same event attributes in event_streams db table except one fake attribute - target_name which is resolved into certain object’s id.

Default match algorithm is ==. Event also accepts match function in order to change default match type.

fixtures.events.pytest_runtest_call(item)[source]
fixtures.events.register_event(list of event attributes)[source]

Event registration fixture.

This fixture is used to notify the testing system that some event should have occurred during execution of the test case using it. It does not register anything by itself.

Parameters:
  • attribute 1 (event) –
  • .. –
  • attribute N (event) –

Returns: None

Usage:

def test_something(foo, bar, register_event, appliance):
    register_event(target_type = 'VmOrTemplate', target_name = vm.name,
        event_type = 'vm_create')
fixtures.fixtureconf module
fixtures.fixtureconf.fixtureconf(request)[source]

Provides easy access to the fixtureconf dict in fixtures

fixtures.log module
fixtures.log.logger()[source]
fixtures.log.pytest_collection_modifyitems(session, config, items)[source]
fixtures.log.pytest_exception_interact(node, call, report)[source]
fixtures.log.pytest_runtest_logreport(report)[source]
fixtures.log.pytest_runtest_setup(item)[source]
fixtures.log.pytest_sessionfinish(session, exitstatus)[source]
fixtures.log.test_tracking = defaultdict(<type 'dict'>, {})

A dict of tests, and their state at various test phases

fixtures.maximized module

Created on Mar 4, 2013

@author: bcrochet

fixtures.maximized.maximized()[source]
fixtures.merkyl module
class fixtures.merkyl.MerkylInspector(request)[source]

Bases: object

add_log(log_name)[source]

Adds a log file to the merkyl process.

This function adds a log file path to the merkyl process on the appliance. This is relevant only for the duration of the test. At the end of the test, the file is removed from the merkyl tracker.

Note that this is a blocking call, ie, we ensure that the file is being logged by merkyl, before we continue. This is important and prevents the file_add operation being queued and processes which generate log information activating before the log is being monitored. This is achieved using the grab_result switch, but in fact, nothing will be received.

It is worth noting that the file path must be “discoverable” by merkyl. This may mean editing the allowed_files prior to deploying merkyl.

Parameters:log_name – Full path to the log file wishing to be monitored.
get_log(log_name)[source]

A simple getter for log files.

Returns the cached content of a particular log

Parameters:log_name – Full path to the log file wishing to be received.
search_log(needle, log_name)[source]

A simple search, test if needle is in cached log_contents.

Does a simple search of needle in contents. Note that this does not trawl the previous contents of the file, but only looks at the log information which has been gathered since merkyl was tracking the file.

fixtures.merkyl.merkyl_inspector(request)[source]

Provides a MerkylInspector instance.

This fixture is used to gain access to a relevant MerkylInspector instance.

Example usage is below:

def test_test(merkyl_inspector):
    merkyl_inspector.add_log('/path/to/log/file')
    # Do something
    if merkyl_inspector.search_log('needle', '/path/to/log/file'):
        print(merkyl_inspector.get_log('/path/to/log/file'))
fixtures.middleware_log module
fixtures.middleware_log.middleware_evm_log_no_error()[source]
fixtures.nelson module
class fixtures.nelson.GoogleDocstring(*args, **kwargs)[source]

Bases: sphinx.ext.napoleon.docstring.GoogleDocstring

Custom version of napoleon’s GoogleDocstring that adds some special cases

fixtures.nelson.get_meta(obj)[source]
fixtures.nelson.pytest_collection_modifyitems(items)[source]
fixtures.nelson.pytest_pycollect_makeitem(collector, name, obj)[source]

pytest hook that adds docstring metadata (if found) to a test’s meta mark

fixtures.nelson.setup(app)[source]

Sphinx extension setup function.

See also

http://sphinx-doc.org/extensions.html

fixtures.nelson.stripper(docstring)[source]

Slightly smarter dedent

It strips a docstring’s first line indentation and dedents the rest

fixtures.node_annotate module
class fixtures.node_annotate.MarkFromMap(mark_map)[source]

Bases: object

classmethod from_parsed_list(parsed, key, map_value)[source]
pytest_itemcollected(item)[source]
fixtures.node_annotate.generate_nodeid(mapping)[source]
fixtures.node_annotate.parse(path)[source]
fixtures.node_annotate.pytest_addoption(parser)[source]
fixtures.node_annotate.pytest_collection_modifyitems(config, items)[source]
fixtures.node_annotate.pytest_configure(config)[source]
fixtures.node_annotate.requirement_matches(item, requirements)[source]
fixtures.node_annotate.tier_matches(item, tiers)[source]
fixtures.page_screenshots module
fixtures.page_screenshots.pytest_addoption(parser)[source]
fixtures.perf module

Fixtures specifically for performance tests.

fixtures.perf.cfme_log_level_rails_debug()[source]
fixtures.perf.ui_worker_pid()[source]
fixtures.portset module
fixtures.portset.pytest_addoption(parser)[source]
fixtures.portset.pytest_configure(config)[source]
fixtures.prov_filter module
fixtures.prov_filter.pytest_addoption(parser)[source]
fixtures.prov_filter.pytest_configure(config)[source]

Filters the list of providers as part of pytest configuration

Note

Additional filter is added to the global_filters dict of active filters here.

fixtures.provider module

Fixtures to set up providers

Used to ensure that we have a provider set up on the appliance before running a test.

There are two ways to request a setup provider depending on what kind of test we create:

  1. Test parametrized by provider (test is run once per each matching provider) For parametrized tests, provider is delivered by testgen. Testgen ensures that the requested provider is available as the provider parameter. It doesn’t set the provider up, however, as it will only provide you with the appropriate provider CRUD object. To get the provider set up, we need to add one of the following fixtures to parameters as well: - setup_provider - setup_provider_modscope - setup_provider_clsscope - setup_provider_funcscope (same as setup_provider)

    This ensures that whatever is currently hiding under the provider parameter will be set up.

  2. Test not parametrized by provider (test is run once and we just need some provider available) In this case, we don’t really care about what sort of a provider we have available. Usually, we just want something to fill the UI with data so that we can test our provider non-specific functionality. For that, we can leverage one of the following fixtures: - infra_provider - cloud_provider - middleware_provider - containers_provider - ...and others

    If these don’t really fit your needs, you can implement your own module-local a_provider fixture using setup_one_by_class_or_skip or more adjustable setup_one_or_skip. These functions do exactly what their names suggest - they setup one of the providers fitting given parameters or skip the test. All of these fixtures are (and should be) function scoped. Please keep that in mind when creating your module-local substitutes.

If setting up a provider fails, the issue is logged and an internal counter is incremented as a result. If this counter reaches a predefined number of failures (see SETUP_FAIL_LIMIT), the failing provider will be added to the list of problematic providers and no further attempts to set it up will be made.

fixtures.provider.big_template(provider)[source]
fixtures.provider.big_template_modscope(provider)[source]
fixtures.provider.console_template(provider)[source]
fixtures.provider.console_template_modscope(provider)[source]
fixtures.provider.full_template(provider)[source]
fixtures.provider.full_template_modscope(provider)[source]
fixtures.provider.has_no_providers(request)[source]
fixtures.provider.has_no_providers_modscope(request)[source]
fixtures.provider.provisioning(provider)[source]
fixtures.provider.pytest_addoption(parser)[source]
fixtures.provider.setup_one_by_class_or_skip(request, prov_class, use_global_filters=True)[source]
fixtures.provider.setup_one_or_skip(request, filters=None, use_global_filters=True)[source]

Sets up one of matching providers or skips the test

Parameters:
  • filters – List of ProviderFilter or None
  • request – Needed for logging a potential skip correctly in artifactor
  • use_global_filters – Will apply global filters as well if True, will not otherwise
fixtures.provider.setup_only_one_provider(request, has_no_providers)[source]
fixtures.provider.setup_or_skip(request, provider)[source]

Sets up given provider or skips the test

Note

If a provider fails to setup SETUP_FAIL_LIMIT times, it will be added to the list of problematic providers and won’t be used by any test until the end of the test run.

fixtures.provider.setup_perf_provider(request, use_global_filters=True)[source]
fixtures.provider.setup_provider(request, provider)[source]

Function-scoped fixture to set up a provider

fixtures.provider.setup_provider_clsscope(request, provider)[source]

Module-scoped fixture to set up a provider

fixtures.provider.setup_provider_funcscope(request, provider)[source]

Function-scoped fixture to set up a provider

fixtures.provider.setup_provider_modscope(request, provider)[source]

Module-scoped fixture to set up a provider

fixtures.provider.small_template(provider)[source]
fixtures.provider.small_template_modscope(provider)[source]
fixtures.provider.template(template_location, provider)[source]
fixtures.pytest_store module

Storage for pytest objects during test runs

The objects in the module will change during the course of a test run, so they have been stashed into the ‘store’ namespace

Usage:

# as pytest.store
import pytest
pytest.store.config, pytest.store.pluginmanager, pytest.store.session

# imported directly (store is pytest.store)
from fixtures.pytest_store import store
store.config, store.pluginmanager, store.session

The availability of these objects varies during a test run, but all should be available in the collection and testing phases of a test run.

class fixtures.pytest_store.FlexibleTerminalReporter(config=None, file=None)[source]

Bases: _pytest.terminal.TerminalReporter

A TerminalReporter stand-in that pretends to work even without a py.test config.

class fixtures.pytest_store.Store[source]

Bases: object

pytest object store

If a property isn’t available for any reason (including being accessed outside of a pytest run), it will be None.

base_url

If there is a current appliance the base url of that appliance is returned else, the base_url from the config is returned.

capturemanager
config = None

The py.test config instance, None if not in py.test

current_appliance
fixturemanager
has_config
in_pytest_session
my_ip_address
parallel_session
parallelizer_role = None

Parallelizer role, None if not running a parallelized session

pluginmanager
session = None

The current py.test session, None if not in a py.test session

slave_manager
slaveid
ssh_clients_to_close = None

hack variable until we get a more sustainable solution

terminaldistreporter
terminalreporter
write_line(line, **kwargs)[source]
fixtures.pytest_store.pytest_namespace()[source]
fixtures.pytest_store.pytest_plugin_registered(manager)[source]
fixtures.pytest_store.pytest_sessionstart(session)[source]
fixtures.pytest_store.write_line(line, **kwargs)[source]

A write-line helper that should always write a line to the terminal

It knows all of py.tests dirty tricks, including ones that we made, and works around them.

Parameters:**kwargs – Normal kwargs for pytest line formatting, stripped from slave messages
fixtures.qa_contact module
fixtures.qa_contact.dig_code(node)[source]
fixtures.qa_contact.pytest_runtest_teardown(item, nextitem)[source]
fixtures.randomness module
fixtures.randomness.random_string()[source]

Generate a random string for use in tests

fixtures.randomness.random_uuid_as_string()[source]

Creates a random uuid and returns is as a string

fixtures.rbac module

RBAC Role based parametrization and checking

The purpose of this fixture is to allow tests to be run within the context of multiple different users, without the hastle or modifying the test. To this end, the RBAC module and fixture do not require any modifications to the test body.

The RBAC fixture starts by receiving a list of roles and associated errors from the test metadata. This data is in YAML format and an example can be seen below.

Metadata:
    test_flag: provision
    suite: infra_provisioning
    rbac:
        roles:
            default:
            evmgroup-super_administrator:
            evmgroup-administrator:
            evmgroup-operator: NoSuchElementException
            evmgroup-auditor: NoSuchElementException

Let’s assume also we have a test that looks like the following:

def test_rbac(rbac_role):
    if rbac_role != 'evmgroup-superadministrator' or rbac_role != 'evmgroup-operator':
        1 / 0

This metadata defines the roles to be tested, and associates with them the exceptions that are expected for that particular test, or blank if no Exception is expected. In this way we can have 5 states of test result.

  • Test Passed - This was expected - We do nothing to this and exit early. In the example above evmgroup-super_administrator fulfills this, as it expects no Exception.
  • Test Failed - This was expected - We consume the Exception and change the result of the test to be a pass. In the example, this is fulfilled by evmgroup-auditor as it was expected to fail with the ZeroDivisionError.
  • Test Failed - This was unexpected - We consume the Exception and raise another informing that the test should have passed. In the example above, evmgroup-administrator satisfies this condition as it didn’t expect a failure, but got one.
  • Test Failed - This was expected, but the wrong Exception appeared - We consume the Exception throw another stating that the Exception wasn’t of the expected type. In the example above, the default user satifies this as it receives the ZeroDivisionError, but expects MonkeyError.
  • Test Passed - This was unexpected - We have Exception to consume, but we raise an Exception of our own as the test should have failed. In the example above, evmgroup-operator satisfies this as it should have received the ZeroDivisionError, but actually passes with no error.

When a test is configured to run against the RBAC suite, it will first parametrize the test with the associated roles from the metadata. The test will then be wrapped and before it begins we login as the new user. This process is also two fold. The pytest_store holds the current user, and logging in is performed with whatever this user value is set to. So we first replace this value with our new user. This ensures that if the browser fails during a navigation, we get the opportunity to log in again with the right user. Once the user is set, we attempt to login.

When the test finishes, we set the user back to default before moving on to handling the outcome of the test with the wrapped hook handler. This ensures that the next test will have the correct user at login, even if the test fails horribly, and even if the inspection of the outcome should fail.

To configure a test to use RBAC is simple. We simply need to add rbac_role to the list of fixtures and the addition and the ldap configuration fixture also. Below is a complete example of adding RBAC to a test.

import pytest

def test_rbac(rbac_role):
""" Tests provisioning from a template

Metadata:
    rbac:
        roles:
            default:
            evmgroup-super_administrator:
            evmgroup-administrator:
            evmgroup-operator: NoSuchElementException
            evmgroup-auditor: NoSuchElementException
"""
    if rbac_role != 'evmgroup-superadministrator' or rbac_role != 'evmgroup-operator':
        1 / 0

Exception matching is done with a simple string startswith match.

Currently there is no provision for skipping a role for a certain test, though this is easy to implement. There is also no provision, for tests that have multiple parameters, to change the expectation of the test, with relation to a parameter. For example, if there was a parameter called rhos and one called ec2 we could not change the expected exception to be different depending on if the test was run against rhos or ec2.

fixtures.rbac.pytest_addoption(parser)[source]
fixtures.rbac.pytest_configure(config)[source]

Filters the list of providers as part of pytest configuration.

fixtures.rbac.pytest_generate_tests(metafunc)[source]
fixtures.rbac.pytest_pyfunc_call(pyfuncitem)[source]

Inspects and consumes certain exceptions

The guts of this function are explained above in the module documentation.

Parameters:pyfuncitem – A pytest test item.
fixtures.rbac.really_logout()[source]

A convenience function logging out

This function simply ensures that we are logged out and that a new browser is loaded ready for use.

fixtures.rbac.save_screenshot(node, ss, sse)[source]
fixtures.rbac.save_traceback_file(node, contents)[source]

A convenience function for artifactor file sending

This function simply takes the nodes id and the contents of the file and processes them and sends them to artifactor

Parameters:
  • node – A pytest node
  • contents – The contents of the traceback file
fixtures.screenshots module

Taking screenshots inside tests!

If you want to take a screenshot inside your test, just do it like this:

def test_my_test(take_screenshot):
    # do something
    take_screenshot("Particular name for the screenshot")
    # do something else
fixtures.screenshots.take_screenshot(request)[source]
fixtures.soft_assert module

Soft assert context manager and assert function

A “soft assert” is an assertion that, if it fails, does not fail the entire test. Soft assertions can be mixed with normal assertions as needed, and will be automatically collected/reported after a test runs.

Functionality Overview
  1. If soft_assert() is used by a test, that test’s call phase is wrapped in a context manager. Entering that context sets up a thread-local store for failed assertions.
  2. Inside the test, soft_assert() is a function with access to the thread-local store of failed assertions, allowing it to store failed assertions during a test run.
  3. After a test runs, the context manager wrapping the test’s call phase exits, which inspects the thread-local store of failed assertions, raising a custom AssertionError if any are found.

No effort is made to clear the thread-local store; rather it’s explicitly overwritten with an empty list by the context manager. Because the store is a list, failed assertions will be reported in the order that they failed.

exception fixtures.soft_assert.SoftAssertionError(failed_assertions)[source]

Bases: exceptions.AssertionError

exception class containing failed assertions

Functions like AssertionError, but also stores the failed soft exceptions that it represents in order to properly display them when cast as str

Parameters:
  • failed_assertions – List of collected assertion failure messages
  • where – Where the SoftAssert context was entered, can be omitted
failed_assertions

failed_assertions handed to the initializer, useful in cases where inspecting the failed soft assertions is desired.

fixtures.soft_assert.handle_assert_artifacts(request, fail_message=None)[source]
fixtures.soft_assert.pytest_runtest_protocol(item, nextitem)[source]
fixtures.soft_assert.pytest_runtest_teardown(item, nextitem)[source]

pytest hook to handle soft_assert() fixture for case when soft_assert is used in another fixture like register_event

fixtures.soft_assert.soft_assert(request)[source]

soft assert fixture, used to defer AssertionError to the end of a test run

Usage:

# contents of test_soft_assert.py, for example
def test_uses_soft_assert(soft_assert):
    soft_assert(True)
    soft_assert(False, 'failure message')

    # soft_assert.catch_assert will intercept AssertionError
    # and turn it into a soft assert
    with soft_assert.catch_assert():
        assert None

    # Soft asserts can be cleared at any point within a test:
    soft_assert.clear_asserts()

    # If more in-depth interaction is desired with the caught_asserts, the list of failure
    # messages can be retrieved. This will return the directly mutable caught_asserts list:
    caught_asserts = soft_assert.caught_asserts()

The test above will report two soft assertion failures, with the following message:

SoftAssertionError:
failure message (test_soft_assert.py:3)
soft_assert(None) (test_soft_assert.py:8)
fixtures.ssh_client module
fixtures.ssh_client.pytest_sessionfinish(session, exitstatus)[source]

Loop through the appliance stack and close ssh connections

fixtures.templateloader module

Preloads all templates on all providers that were selected for testing. Useful for test collect.

fixtures.templateloader.pytest_addoption(parser)[source]
fixtures.templateloader.pytest_configure(config)[source]
fixtures.terminalreporter module
fixtures.terminalreporter.disable()[source]
fixtures.terminalreporter.enable()[source]
fixtures.terminalreporter.reporter(config=None)[source]

Return a py.test terminal reporter that will write to the console no matter what

Only useful when trying to write to the console before or during a pytest_configure hook.

fixtures.ui_coverage module

UI Coverage for a CFME/MIQ Appliance

Usage

py.test --ui-coverage

General Notes

simplecov can merge test results, but doesn’t appear to like working in a multi-process environment. Specifically, it clobbers its own results when running simultaneously in multiple processes. To solve this, each process records its output to its own directory (configured in coverage_hook). All of the individual process’ results are then manually merged (coverage_merger) into one big json result, and handed back to simplecov which generates the compiled html (for humans) and rcov (for jenkins) reports.

thing_toucher makes a best-effort pass at requiring all of the ruby files in the rails root, as well as any external MIQ libs/utils outside of the rails root (../lib and ../lib/util). This makes sure files that are never required still show up in the coverage report.

Workflow Overview

Pre-testing (pytest_configure hook):

  1. Add Gemfile.dev.rb to the rails root, then run bundler to install simplecov and its dependencies.
  2. Install and require the coverage hook (copy coverage_hook to config/, add require line to the end of config/boot.rb)
  3. Restart EVM (Rudely) to start running coverage on the appliance processes: killall -9 ruby; sysemctl start evmserverd
  4. TOUCH ALL THE THINGS (run thing_toucher.rb with the rails runner). Fork this process off and come back to it later

Post-testing (pytest_unconfigure hook):

  1. Poll thing_toucher to make sure it completed; block if needed.
  2. Stop EVM, but nicely this time so the coverage atexit hooks run: systemctl stop evmserverd
  3. Run coverage_merger.rb with the rails runner, which compiles all the individual process reports and runs coverage again, additionally creating an rcov report
  4. Pull the coverage dir back for parsing and archiving
  5. For fun: Read the results from coverage/.last_run.json and print it to the test terminal/log

Post-testing (e.g. ci environment): 1. Use the generated rcov report with the ruby stats plugin to get a coverage graph 2. Zip up and archive the entire coverage dir for review

class fixtures.ui_coverage.CoverageManager(ipappliance)[source]

Bases: object

collect()[source]
collection_appliance
install()[source]
merge()[source]
print_message(message)[source]
class fixtures.ui_coverage.UiCoveragePlugin[source]

Bases: object

pytest_collection_finish()[source]
pytest_configure(config)[source]
pytest_sessionfinish(exitstatus)[source]
pytest_sessionstart(session)[source]
fixtures.ui_coverage.appliance_coverage_root = local('/var/www/miq/vmdb/coverage')

coverage root, should match what’s in the coverage hook and merger scripts

fixtures.ui_coverage.clean_coverage_dir()[source]
fixtures.ui_coverage.manager()[source]
fixtures.ui_coverage.pytest_addoption(parser)[source]
fixtures.ui_coverage.pytest_cmdline_main(config)[source]
fixtures.ui_coverage.rails_root = local('/var/www/miq/vmdb')

Corresponds to Rails.root in the rails env

fixtures.version_file module
fixtures.version_file.pytest_sessionstart()[source]
fixtures.version_info module
fixtures.version_info.find_nth_pos(string, substring, n)[source]

helper-method used in getting version info

fixtures.version_info.generate_gems_file(ssh_client, directory)[source]
fixtures.version_info.generate_processes_file(ssh_client, directory)[source]
fixtures.version_info.generate_rpms_file(ssh_client, directory)[source]
fixtures.version_info.generate_system_file(ssh_client, directory)[source]
fixtures.version_info.generate_version_files()[source]
fixtures.version_info.get_gem_versions(ssh_client)[source]

get version information for gems

fixtures.version_info.get_process_versions(ssh_client)[source]

get version information for processes

fixtures.version_info.get_rpm_versions(ssh_client)[source]

get version information for rpms

fixtures.version_info.get_system_versions(ssh_client)[source]

get version information for the system

fixtures.video module

Provides video options

Yaml example:
logging:
   video:
       enabled: True
       dir: video
       display: ":99"
       quality: 10
fixtures.video.get_path_and_file_name(node)[source]

Extract filename and location from the node.

Parameters:node – py.test collection node to examine.

Returns: 2-tuple (path, filename)

fixtures.video.pytest_runtest_setup(item)[source]
fixtures.video.pytest_runtest_teardown(item, nextitem)[source]
fixtures.video.pytest_unconfigure(config)[source]
fixtures.video.stop_recording()[source]
fixtures.virtual_machine module

Fixtures ensuring that a VM/instance is in the specified state for the test

fixtures.virtual_machine.verify_vm_paused(provider, vm_name)[source]

Ensures that the VM/instance is paused for the test

Uses calls to the actual provider api; it will pause the vm if necessary.

Parameters:
  • provider.mgmt – Provider class object
  • vm_name – Name of the VM/instance
fixtures.virtual_machine.verify_vm_running(provider, vm_name)[source]

Ensures that the VM/instance is in running state for the test

Uses calls to the actual provider api; it will start the vm if necessary.

Parameters:
  • provider – Provider class object
  • vm_name – Name of the VM/instance
fixtures.virtual_machine.verify_vm_stopped(provider, vm_name)[source]

Ensures that the VM/instance is stopped for the test

Uses calls to the actual provider api; it will stop the vm if necessary.

Parameters:
  • provider – Provider class object
  • vm_name – Name of the VM/instance
fixtures.virtual_machine.verify_vm_suspended(provider, vm_name)[source]

Ensures that the VM/instance is suspended for the test

Uses calls to the actual provider api; it will suspend the vm if necessary.

Parameters:
  • provider.mgmt – Provider class object
  • vm_name – Name of the VM/instance
fixtures.widgets module
fixtures.widgets.widgets_generated(setup_only_one_provider)[source]
fixtures.xunit_tools module
fixtures.xunit_tools.gen_duplicates_log(items)[source]

Generates log file containing non-unique test cases names.

fixtures.xunit_tools.get_polarion_name(item)[source]

Gets Polarion test case name out of the Node ID.

fixtures.xunit_tools.get_testcase_data(tests, test_names, item, legacy=False)[source]

Gets data for single testcase entry.

fixtures.xunit_tools.get_testresult_data(tests, test_names, item, legacy=False)[source]

Gets data for single test result entry.

fixtures.xunit_tools.pytest_addoption(parser)[source]

Adds command line options.

fixtures.xunit_tools.pytest_collection_modifyitems(config, items)[source]

Generates the XML files using collected items.

fixtures.xunit_tools.testcase_record(test_name, description=None, parameters=None, custom_fields=None, linked_items=None)[source]

Generates single testcase entry.

fixtures.xunit_tools.testcases_gen(tests, filename)[source]

Generates content of the XML file used for test cases import.

fixtures.xunit_tools.testresult_record(test_name, parameters=None, result=None)[source]

Generates single test result entry.

fixtures.xunit_tools.testrun_gen(tests, filename, config, collectonly=True)[source]

Generates content of the XML file used for test run import.

Module contents

markers package

Subpackages

markers.env_markers package
Submodules
markers.env_markers.provider module
class markers.env_markers.provider.ProviderEnvironmentMarker[source]

Bases: markers.env.EnvironmentMarker

NAME = 'provider'
process_env_mark(metafunc)[source]
markers.env_markers.provider.parametrize(metafunc, argnames, argvalues, *args, **kwargs)[source]

parametrize wrapper that calls _param_check(), and only parametrizes when needed

This can be used in any place where conditional parametrization is used.

markers.env_markers.provider.providers(metafunc, filters=None, selector='all')[source]

Gets providers based on given (+ global) filters

Note

Using the default ‘function’ scope, each test will be run individually for each provider before moving on to the next test. To group all tests related to single provider together, parametrize tests in the ‘module’ scope.

Note

testgen for providers now requires the usage of test_flags for collection to work. Please visit http://cfme-tests.readthedocs.org/guides/documenting.html#documenting-tests for more details.

markers.env_markers.provider.providers_by_class(metafunc, classes, required_fields=None, selector='all')[source]

Gets providers by their class

Parameters:
  • metafunc – Passed in by pytest
  • classes – List of classes to fetch
  • required_fields – See cfme.utils.provider.ProviderFilter

Usage:

# In the function itself
def pytest_generate_tests(metafunc):
    argnames, argvalues, idlist = testgen.providers_by_class(
        [GCEProvider, AzureProvider], required_fields=['provisioning']
    )
metafunc.parametrize(argnames, argvalues, ids=idlist, scope='module')

# Using the parametrize wrapper
pytest_generate_tests = testgen.parametrize([GCEProvider], scope='module')
Module contents

Submodules

markers.composite module
markers.composite.pytest_addoption(parser)[source]

Adds options for the composite uncollection system

markers.composite.pytest_collection_modifyitems(session, config, items)[source]
markers.crud module

crud: Marker for marking the test as a CRUD test (crud)

Useful for eg. running only crud tests. Tests will be marked automatically if:

  • their name starts with crud_
  • their name ends with _crud
  • their name contains _crud_
markers.crud.pytest_configure(config)[source]
markers.crud.pytest_itemcollected(item)[source]
markers.env module

This file provides multiple markers for environmental parameters

A test can be marked with

@pytest.mark.browser(ALL) @pytest.mark.browser(NONE) @pytest.mark.browser(‘firefox’)

At the moment, lists of parameters are not supported

class markers.env.BrowserEnvironmentMarker[source]

Bases: markers.env.EnvironmentMarker

Browser Envrionment Marker

CHOICES = ['firefox', 'chrome', 'ie']
NAME = 'browser'
class markers.env.EnvironmentMarker[source]

Bases: object

Base Environment Marker

PARAM_BY_DEFAULT = False
process_env_mark(metafunc)[source]
class markers.env.TCPEnvironmentMarker[source]

Bases: markers.env.EnvironmentMarker

TCP Environment Marker

CHOICES = ['ipv4', 'ipv6']
NAME = 'tcpstack'
markers.env.pytest_generate_tests(metafunc)[source]
markers.fixtureconf module

fixtureconf: Marker for passing args and kwargs to test fixtures

Positional and keyword arguments to this marker will be stored on test items in the _fixtureconf attribute (dict). kwargs will be stored as-is, the args tuple will be packed into the dict under the ‘args’ key.

Use the “fixtureconf” fixture in tests to easily access the fixtureconf dict

markers.fixtureconf.pytest_configure(config)[source]
markers.fixtureconf.pytest_runtest_setup(item)[source]
markers.manual module

manual: Marker for marking tests asmanual tests.

markers.manual.pytest_addoption(parser)[source]

Adds options for the composite uncollection system

markers.manual.pytest_collection_modifyitems(session, config, items)[source]
markers.manual.pytest_configure(config)[source]
markers.meta module

meta(**metadata): Marker for metadata addition.

To add metadata to a test simply pass the kwargs as plugins wish.

You can write your own plugins. They generally live in metaplugins/ directory but you can define them pretty much everywhere py.test loads modules. Plugin has a name and a set of callbacks that are called when certain combination of keys is present in the metadata.

To define plugin, do like this:

@plugin("plugin_name")
def someaction(plugin_name):
    print(plugin_name)  # Will contain value of `plugin_name` key of metadict

This is the simplest usage, where it is supposed that the plugin checks only one key with the same name s the plugin’s name. I won’t use this one in the latter examples, I will use the more verbose one.

@plugin("plugin_name", keys=["plugin_name", "another_key"])
def someaction(plugin_name, another_key):
    print(plugin_name)  # Will contain value of `plugin_name` key of metadict
    print(another_key)  # Similarly this one

This one reacts when the two keys are present. You can make even more complex setups:

@plugin("plugin_name", keys=["plugin_name"])
@plugin("plugin_name", ["plugin_name", "another_key"])  # You don't have to write keys=
def someaction(plugin_name, another_key=None):
    print(plugin_name)  # Will contain value of `plugin_name` key of metadict
    print(another_key)  # Similarly this one if specified, otherwise None

This created a nonrequired parameter for the action.

You can specify as many actions as you wish per plugin. The only thing that limits you is the correct action choice. First, all the actions are filtered by present keys in metadata. Then after this selection, only the action with the most matched keywords is called. Bear this in your mind. If this is not enough in the future, it can be extended if you wish.

It has a command-line option that allows you to disable certain plugins. Just specify --disablemetaplugins a,b,c where a, b and c are the plugins that should be disabled

class markers.meta.Plugin(name, metas, function, kwargs)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

function

Alias for field number 2

kwargs

Alias for field number 3

metas

Alias for field number 1

name

Alias for field number 0

class markers.meta.PluginContainer[source]

Bases: object

AFTER_RUN = 'after_run'
BEFORE_RUN = 'before_run'
DEFAULT = 'setup'
SETUP = 'setup'
TEARDOWN = 'teardown'
markers.meta.meta(request)[source]
markers.meta.pytest_addoption(parser)[source]
markers.meta.pytest_collection_modifyitems(session, config, items)[source]
markers.meta.pytest_configure(config)[source]
markers.meta.pytest_pycollect_makeitem(collector, name, obj)[source]
markers.meta.pytest_runtest_call(item)[source]
markers.meta.pytest_runtest_setup(item)[source]
markers.meta.pytest_runtest_teardown(item)[source]
markers.meta.run_plugins(item, when)[source]
markers.polarion module

polarion(*tcid): Marker for marking tests as automation for polarion test cases.

markers.polarion.extract_polarion_ids(item)[source]

Extracts Polarion TC IDs from the test item. Returns None if no marker present.

markers.polarion.pytest_configure(config)[source]
markers.requires module

requires_test(test_name_or_nodeid): Mark a test as requiring another test

If another test is required to have run and passed before a suite of tests has any hope of succeeding, such as a smoke test, apply this mark to those tests.

It takes a test name as the only positional argument. In the event that the test name is ambiguous, a full py.test nodeid can be used. A test’s nodeid can be found by inspecting the request.node.nodeid attribute inside the required test item.

markers.requires.pytest_configure(config)[source]
markers.requires.pytest_runtest_setup(item)[source]
markers.sauce module

sauce: Mark a test to run on sauce

Mark a single test to run on sauce.

markers.sauce.pytest_addoption(parser)[source]
markers.sauce.pytest_configure(config)[source]
markers.skipper module

skipper: Autmatically skip tests with certain marks as defined in this module

This doesn’t provide any special markers, but it does add behavor to marks defined in skip_marks.

markers.skipper.pytest_addoption(parser)[source]
markers.skipper.pytest_collection_modifyitems(items)[source]
markers.skipper.pytest_configure(config)[source]
markers.skipper.skip_marks = [('long_running', '--long-running'), ('perf', '--perf')]

List of (mark, commandline flag) tuples. When the given mark is used on a test, it will be skipped unless the commandline flag is used. If the mark is already found in py.test’s parsed mark expression, no changes will be made for that mark.

markers.smoke module

smoke: Mark a test as a smoke test to be run as early as possible

Mark a single test as a smoke test, moving it to the beginning of a test run.

The –halt-on-smoke-test-failure command-line argument will halt after running the smoke tests if any smoke tests fail.

This mark must be used with caution, as marked tests must be able to run out of order, and in isolation.

Furthermore, smoke tests are an excellent target for the requires_test mark since they’re run first.

class markers.smoke.SmokeTests(reporter)[source]

Bases: object

complete = False
failed_tests = 0
halt_on_fail = False
pytest_runtest_logreport(report)[source]
pytest_runtest_teardown(item, nextitem)[source]
reported = False
run_tests = 0
start_time = 0.0
markers.smoke.pytest_addoption(parser)[source]
markers.smoke.pytest_collection_modifyitems(session, config, items)[source]
markers.smoke.pytest_configure(config)[source]
markers.smoke.reporter(config)[source]
markers.stream_excluder module

ignore_stream(*streams): Marker for uncollecting the tests based on appliance stream.

Streams are the first two fields from version of the appliance (5.0, 5.1, ...), the nightly upstream is represented as upstream. If you want to ensure, that the test shall not be collected because it is not supposed to run on 5.0 and 5.1 streams, just put those streams in the parameters and that is enough.

It also provides a facility to check the appliance’s version/stream for smoke testing.

markers.stream_excluder.get_streams_id()[source]
markers.stream_excluder.pytest_addoption(parser)[source]
markers.stream_excluder.pytest_collection_modifyitems(session, config, items)[source]
markers.stream_excluder.pytest_configure(config)[source]
markers.stream_excluder.pytest_itemcollected(item)[source]
markers.uncollect module
uncollect

Used internally to mark a test to be “uncollected”

This mark should be used at any point before or during test collection to dynamically flag a test to be removed from the list of collected tests.

py.test adds marks to test items a few different ways. When marking in a py.test hook that takes an Item or Node (Item is a subclass of Node), use item.add_marker('uncollect') or item.add_marker(pytest.mark.uncollect)

When dealing with the test function directly, using the mark decorator is preferred. In this case, either decorate a test function directly (and have a good argument ready for adding a test that won’t run...), e.g. @pytest.mark.uncollect before the test def, or instantiate the mark decorator and use it to wrap a test function, e.g. pytest.mark.uncollect()(test_function)

uncollectif

The uncollectif marker is very special and can cause harm to innocent kittens if used incorrectly. The uncollectif marker enables the ability to uncollect a specific test if a certain condition is evaluated to True. The following is an example:

@pytest.mark.uncollectif(lambda: version.current_version() < '5.3')

In this case, when pytest runs the modify items hook, it will evaluate the lambda function and if it results in True, then the test will be uncollected. Fixtures that are generated by testgen, such as provider_key, provider_data etc, are also usable inside the collectif marker, assuming the fixture name is also a prerequisite for the test itself. For example:: python

@pytest.mark.uncollectif(lambda provider_type: provider_type != 'virtualcenter')
def test_delete_all_snapshots(test_vm, provider_key, provider_type):
    pass

Here, the fixture provider_type is special as it comes from testgen and is passed to the lambda for comparison.

Note

Be aware, that this cannot be used for any other fixture types. Doing so will break pytest and may invalidate your puppies.

markers.uncollect.get_uncollect_function(marker_or_markdecorator)[source]
markers.uncollect.pytest_collection_modifyitems(session, config, items)[source]
markers.uncollect.uncollectif(item)[source]

Evaluates if an item should be uncollected

Tests markers against a supplied lambda from the marker object to determine if the item should be uncollected or not.

markers.uses module

uses_*: Provides a set of fixtures used to mark tests for filtering on the command-line.

Tests using these fixtures directly or indirectly can be filtered using py.test’s -k filter argument. For example, run tests that use the ssh client:

py.test -k uses_ssh

Additionally, tests using one of the fixtures listed in appliance_marks will be marked with is_appliance, for easily filtering out appliance tests, e.g:

py.test -k 'not is_appliance'

All fixtures created by this module will have the uses_ prefix.

Note

is_appliance is a mark that will be dynamically set based on fixtures used, but is not a fixture itself.

markers.uses.appliance_marks = set(['uses_ssh', 'uses_db'])

List of fixtures that, when used, indicate an appliance is being tested by applying the is_appliance mark.

markers.uses.pytest_itemcollected(item)[source]

pytest hook that actually does the marking

See: http://pytest.org/latest/plugins.html#_pytest.hookspec.pytest_collection_modifyitems

markers.uses.uses_blockers()

Fixture which marks a test with the uses_blockers mark

markers.uses.uses_cloud_providers(uses_providers)[source]

Fixture which marks a test with the uses_cloud_providers and uses_providers marks

markers.uses.uses_db()

Fixture which marks a test with the uses_db mark

markers.uses.uses_event_listener()

Fixture which marks a test with the uses_event_listener mark

markers.uses.uses_infra_providers(uses_providers)[source]

Fixture which marks a test with the uses_infra_providers and uses_providers marks

markers.uses.uses_providers()

Fixture which marks a test with the uses_providers mark

markers.uses.uses_pxe()

Fixture which marks a test with the uses_pxe mark

markers.uses.uses_ssh()

Fixture which marks a test with the uses_ssh mark

Module contents

utils package

Subpackages

utils.appliance package
Subpackages
utils.appliance.implementations package
Submodules
utils.appliance.implementations.ssui module
class utils.appliance.implementations.ssui.MiqSSUIBrowser(selenium, endpoint, extra_objects=None)[source]

Bases: widgetastic.browser.Browser

appliance
create_view(*args, **kwargs)[source]
product_version
class utils.appliance.implementations.ssui.SSUINavigateStep(obj, navigate_obj)[source]

Bases: navmazing.NavigateStep

VIEW = None
am_i_here()[source]
appliance
create_view(*args, **kwargs)[source]
do_nav(_tries=0, *args, **kwargs)[source]

Describes how the navigation should take place.

go(_tries=0)[source]
pre_navigate(*args, **kwargs)[source]
view
class utils.appliance.implementations.ssui.ViaSSUI(owner)[source]

Bases: utils.appliance.implementations.Implementation

widgetastic

This gives us a widgetastic browser.

utils.appliance.implementations.ui module
class utils.appliance.implementations.ui.CFMENavigateStep(obj, navigate_obj)[source]

Bases: navmazing.NavigateStep

VIEW = None
am_i_here()[source]
appliance
check_for_badness(fn, _tries, nav_args, *args, **kwargs)[source]
construst_message(here, resetter, view, duration)[source]
create_view(*args, **kwargs)[source]
go(_tries=0, *args, **kwargs)[source]
log_message(msg, level='debug')[source]
post_navigate(*args, **kwargs)[source]
pre_navigate(*args, **kwargs)[source]
resetter(*args, **kwargs)[source]
view
class utils.appliance.implementations.ui.ErrorView(parent, logger=None, **kwargs)[source]

Bases: widgetastic.widget.View

body

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

error_text

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

get_rails_error()[source]

Gets the displayed error messages

title

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class utils.appliance.implementations.ui.MiqBrowser(selenium, endpoint, extra_objects=None)[source]

Bases: widgetastic.browser.Browser

appliance
create_view(*args, **kwargs)[source]
product_version
class utils.appliance.implementations.ui.MiqBrowserPlugin(browser)[source]

Bases: widgetastic.browser.DefaultPlugin

DEFAULT_WAIT = 0.8
ENSURE_PAGE_SAFE = 'function isHidden(el){if(el===null)return true;return el.offsetParent===null;}\ntry{angular.element(\'error-modal\').hide();}catch(err){}\ntry{return!ManageIQ.qe.anythingInFlight();}catch(err){return(((typeof $==="undefined")?true:$.active<1)&&(!((!isHidden(document.getElementById("spinner_div")))&&isHidden(document.getElementById("lightbox_div"))))&&document.readyState=="complete"&&((typeof checkMiqQE==="undefined")?true:checkMiqQE(\'autofocus\')<1)&&((typeof checkMiqQE==="undefined")?true:checkMiqQE(\'debounce\')<1)&&((typeof checkAllMiqQE==="undefined")?true:checkAllMiqQE()<1));}'
OBSERVED_FIELD_MARKERS = ('data-miq_observe', 'data-miq_observe_date', 'data-miq_observe_checkbox')
after_keyboard_input(element, keyboard_input)[source]
ensure_page_safe(timeout='10s')[source]
class utils.appliance.implementations.ui.ViaUI(owner)[source]

Bases: utils.appliance.implementations.Implementation

UI implementation using the normal ux

widgetastic

This gives us a widgetastic browser.

utils.appliance.implementations.ui.can_skip_badness_test(fn)[source]

Decorator for setting a noop

Module contents
class utils.appliance.implementations.Implementation(owner)[source]

Bases: object

UI implementation using the normal ux

appliance
create_view(view_class, additional_context=None)[source]

Method that is used to instantiate a Widgetastic View.

Views may define LOCATION on them, that implies a force_navigate() call with LOCATION as parameter.

Parameters:
  • view_class – A view class, subclass of widgetastic.widget.View
  • additional_context – Additional informations passed to the view (user name, VM name, ...) which is also passed to the force_navigate() in case when navigation is requested.
Returns:

An instance of the view_class
open_browser(url_key=None)[source]
quit_browser()[source]
Submodules
utils.appliance.db module
class utils.appliance.db.ApplianceDB(appliance, ssh_client=None)[source]

Bases: utils.appliance.plugin.AppliancePlugin

Holder for appliance DB related methods and functions

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

address
backup(database_path='/tmp/evm_db.backup')[source]

Backup VMDB database

client
drop()[source]

Drops the vmdb_production database

Note: EVM service has to be stopped for this to work.

enable_external(db_address, region=0, db_name=None, db_username=None, db_password=None)[source]

Enables external database

Parameters:
  • db_address – Address of the external database
  • region – Number of region to join
  • db_name – Name of the external DB
  • db_username – Username to access the external DB
  • db_password – Password to access the external DB

Returns a tuple of (exitstatus, script_output) for reporting, if desired

enable_internal(region=0, key_address=None, db_password=None, ssh_password=None)[source]

Enables internal database

Parameters:
  • region – Region number of the CFME appliance.
  • key_address – Address of CFME appliance where key can be fetched.

Note

If key_address is None, a new encryption key is generated for the appliance.

extend_partition()[source]

Extends the /var partition with DB while shrinking the unused /repo partition

has_database

Does database have a database defined

has_tables

Does database have tables defined

is_dedicated_active
is_enabled

Is database enabled

is_internal

Is database internal

is_online

Is database online

is_partition_extended
is_ready

Is database ready

loosen_pgssl(with_ssl=False)[source]

Loosens postgres connections

postgres_version = 'rh-postgresql95'
restore(database_path='/tmp/evm_db.backup')[source]

Restore VMDB database

service_name = 'rh-postgresql95-postgresql'
setup(**kwargs)[source]

Configure database

On downstream appliances, invokes the internal database setup. On all appliances waits for database to be ready.

ssh_client
start_db_service()[source]

Starts the postgresql service via systemctl

stop_db_service()[source]

Starts the postgresql service via systemctl

wait_for(timeout=600)[source]

Waits for appliance database to be ready

Parameters:timeout – Number of seconds to wait until timeout (default 180)
exception utils.appliance.db.ApplianceDBException[source]

Bases: utils.appliance.plugin.AppliancePluginException

Basic Exception for Appliance DB object

utils.appliance.plugin module
class utils.appliance.plugin.AppliancePlugin(appliance)[source]

Bases: object

Base class for all appliance plugins.

Usage:

.. code-block:: python

    class IPAppliance(object):
        # ...

        foo = FooPlugin.declare(parameter='value')

Instance of such plugin is then created upon first access.

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

appliance = Attribute(name='appliance', default=NOTHING, validator=None, repr=False, cmp=True, hash=None, init=True, convert=<built-in function proxy>, metadata=mappingproxy({}))
classmethod declare(**kwargs)[source]
logger
class utils.appliance.plugin.AppliancePluginDescriptor(cls, args, kwargs)[source]

Bases: object

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

args
cache
cls
kwargs
exception utils.appliance.plugin.AppliancePluginException[source]

Bases: exceptions.Exception

Base class for all custom exceptions raised from plugins.

utils.appliance.services module
exception utils.appliance.services.SystemdException[source]

Bases: utils.appliance.plugin.AppliancePluginException

class utils.appliance.services.SystemdService(appliance, unit_name)[source]

Bases: utils.appliance.plugin.AppliancePlugin

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

enable()[source]
restart()[source]
running
start()[source]
stop()[source]
unit_name = Attribute(name='unit_name', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
wait_for_running(timeout=600)[source]
Module contents
class utils.appliance.Appliance(provider_name, vm_name, browser_steal=False, container=None)[source]

Bases: utils.appliance.IPAppliance

Appliance represents an already provisioned cfme appliance vm

Parameters:
  • provider_name – Name of the provider this appliance is running under
  • vm_name – Name of the VM this appliance is running as
  • browser_steal – Setting of the browser_steal attribute.
CONFIG_MAPPING = {'vm_name': 'vm_name', 'provider_name': 'provider_name', 'container': 'container'}
CONFIG_NONGLOBAL = set(['vm_name'])
add_rhev_direct_lun_disk(log_callback=None)[source]
address
configure(*args, **kwargs)
configure_fleecing(*args, **kwargs)
destroy()[source]

Destroys the VM this appliance is running as

does_vm_exist()[source]
ipapp
is_on_rhev
is_on_vsphere
is_running
provider

Note

Cannot be cached because provider object is unpickable.

remove_rhev_direct_lun_disk(*args, **kwargs)
rename(new_name)[source]

Changes appliance name

Parameters:new_name – Name to set

Note

Database must be up and running and evm service must be (re)started afterwards for the name change to take effect.

start()[source]

Starts the VM this appliance is running as

stop()[source]

Stops the VM this appliance is running as

templatize(seal=True)[source]

Marks the appliance as a template. Destroys the original VM in the process.

By default it runs the sealing process. If you have done it differently, you can opt out.

Parameters:seal – Whether to run the sealing process (making the VM ‘universal’).
vm_name

VM’s name of the appliance on the provider

class utils.appliance.ApplianceConsole(appliance)[source]

Bases: object

ApplianceConsole is used for navigating and running appliance_console commands against an appliance.

run_commands(commands, autoreturn=True, timeout=20, channel=None)[source]
timezone_check(timezone)[source]
class utils.appliance.ApplianceConsoleCli(appliance)[source]

Bases: object

configure_appliance_external_create(region, dbhostname, username, password, dbname, fetch_key, sshlogin, sshpass)[source]
configure_appliance_external_join(dbhostname, username, password, dbname, fetch_key, sshlogin, sshpass)[source]
configure_appliance_internal_fetch_key(region, dbhostname, username, password, dbname, fetch_key, sshlogin, sshpass)[source]
configure_ipa(ipaserver, username, password, domain, realm)[source]
set_hostname(hostname)[source]
uninstall_ipa_client()[source]
exception utils.appliance.ApplianceException[source]

Bases: exceptions.Exception

class utils.appliance.ApplianceStack[source]

Bases: werkzeug.local.LocalStack

pop()[source]
push(obj)[source]
class utils.appliance.CurrentAppliance(*args, **kwargs)[source]

Bases: object

class utils.appliance.IPAppliance(address=None, browser_steal=False, container=None, openshift_creds=None, db_host=None, db_port=None, ssh_port=None)[source]

Bases: object

IPAppliance represents an already provisioned cfme appliance whos provider is unknown but who has an IP address. This has a lot of core functionality that Appliance uses, since it knows both the provider, vm_name and can there for derive the IP address.

Parameters:
  • ipaddress – The IP address of the provider
  • browser_steal – If True then then current browser is killed and the new appliance is used to generate a new session.
  • container – If the appliance is running as a container or as a pod, specifies its name.
  • openshift_creds – If the appliance runs as a project on openshift, provides credentials for the openshift host so the framework can interact with the project.
  • db_host – If the database is located somewhere else than on the appliance itself, specify the host here.
  • db_port – Database port.
  • ssh_port – SSH port.
CONFIG_MAPPING = {'container': 'container', 'db_host': 'db_host', 'ssh_port': 'ssh_port', 'openshift_creds': 'openshift_creds', 'pod': 'container', 'db_port': 'db_port', 'base_url': 'address', 'browser_steal': 'browser_steal'}
CONFIG_NONGLOBAL = set(['base_url'])
__call__(**kwargs)[source]

Syntactic sugar for overriding certain instance variables for context managers.

Currently possible variables are:

  • browser_steal
__enter__()[source]

This method will replace the current appliance in the store

add_pglogical_replication_subscription(host)[source]

Add a pglogical replication subscription without using the Web UI.

add_product_repo(repo_url, **kwargs)[source]
This method ensures that when we add a new repo URL, there will be no other version
of such product present in the yum.repos.d. You can specify conf options in kwargs. They will be applied only to newly created repo file.
Returns:The repo id.
address
appliance
as_json

Dumps the arguments that can create this appliance as a JSON. None values are ignored.

build
build_date
build_datetime
check_domain_enabled(domain)[source]
clean_appliance()[source]
clone_domain(*args, **kwargs)
company_name
configuration_details

Return details that are necessary to navigate through Configuration accordions.

Parameters:ip_address – IP address of the server to match. If None, uses hostname from conf.env['base_url']
Returns:If the data weren’t found in the DB, NoneType If the data were found, it returns tuple (region, server name, server id, server zone id)
configure(*args, **kwargs)
configure_appliance_for_openldap_ext_auth(appliance_fqdn)[source]
This method changes the /etc/sssd/sssd.conf and /etc/openldap/ldap.conf files to set
up the appliance for an external authentication with OpenLdap. Apache file configurations are updated, for webui to take effect.
Parameters:appliance_name – FQDN for the appliance.
configure_gce(*args, **kwargs)
configure_vm_console_cert(*args, **kwargs)
coverage
db
default_zone
delete_all_providers()[source]
deploy_merkyl(*args, **kwargs)
diagnose_evm_failure()[source]

Go through various EVM processes, trying to figure out what fails

Returns: A string describing the error, or None if no errors occurred.

This is intended to be run after an appliance is configured but failed for some reason, such as in the template tester.

enable_disable_repo(repo_id, enable)[source]
event_listener()[source]

Returns an instance of the event listening class pointed to this appliance.

evm_id
evmserverd
find_product_repos()[source]

Returns a dictionary of products, where the keys are names of product (repos) and values are dictionaries where keys are the versions and values the names of the repositories.

fix_ntp_clock(*args, **kwargs)
classmethod from_json(json_string)[source]
classmethod from_url(url)[source]
get(cls, *args, **kwargs)[source]

A generic getter for instantiation of Collection classes

This generic getter will supply an appliance (self) to an object and instantiate it with the supplied args/kwargs e.g.:

my_appliance.get(NodeCollection)

This will return a NodeCollection object that is bound to the appliance.

get_host_address
get_repofile_list()[source]

Returns list of repofiles present at the appliance.

Ignores certain files, like redhat.repo.

get_yaml_config()[source]
guid
has_cli
has_netapp()[source]
host_id(hostname)[source]
hostname
install_netapp_sdk(*args, **kwargs)
install_vddk(*args, **kwargs)
is_downstream
is_embedded_ansible_running
is_embedded_ensible_role_enabled
is_evm_service_running(*args, **kwargs)
is_idle

Return appliance idle state measured by last production.log activity. It runs one liner script, which first gathers current date on appliance and then gathers date of last entry in production.log(which has to be parsed) with /api calls filtered (These calls occur every minute.) Then it deducts that last time in log from current date and if it is lower than idle_time it returns False else True.

Args:

Returns:True if appliance is idling for longer or equal to idle_time seconds. False if appliance is not idling for longer or equal to idle_time seconds.
is_miqqe_patch_candidate
is_registration_complete(used_repo_or_channel)[source]

Checks if an appliance has the correct repos enabled with RHSM or SAT6

is_ssh_running
is_storage_enabled
is_supervisord_running
is_web_ui_running(unsure=False)[source]

Triple checks if web UI is up and running

Parameters:unsure – Variable to return when not sure if web UI is running or not (default False)
log
managed_known_providers

Returns a set of provider crud objects of known providers managed by this appliance

Note

Recognized by name only.

managed_provider_names

Returns a list of names for all providers configured on the appliance

Note

Unlike managed_known_providers, this will also return names of providers that were not recognized, but are present.

miqqe_patch_applied
miqqe_version

Returns version of applied JS patch or None if not present

new_rest_api_instance(entry_point=None, auth=None, logger='default', verify_ssl=False)[source]

Returns new REST API instance.

os_version
patch_with_miqqe(*args, **kwargs)
precompile_assets(*args, **kwargs)
product_name
product_url_regexp = <_sre.SRE_Pattern object at 0x3f24510>
read_repos()[source]

Reads repofiles so it gives you mapping of id and url.

reboot(*args, **kwargs)
reset_automate_model()[source]
rest_api
rest_logger
restart_evm_service(*args, **kwargs)
scheme
seal_for_templatizing()[source]

Prepares the VM to be “generalized” for saving as a template.

server
server_details_changed()[source]
server_id()[source]
server_name()[source]
server_region()[source]
server_region_string()[source]
server_roles

Return a dictionary of server roles from database

server_zone_id()[source]
set_cap_and_util_all_via_rails()[source]

Turns on Collect for All Clusters and Collect for all Datastores without using Web UI.

set_cfme_server_relationship(vm_name, server_id=1)[source]

Set MiqServer record to the id of a VM by name, effectively setting the CFME Server Relationship without using the Web UI.

set_full_refresh_threshold(threshold=100)[source]
set_pglogical_replication(replication_type=':none')[source]

Set pglogical replication type (:none, :remote, :global) without using the Web UI.

set_rubyrep_replication(host, port=5432, database='vmdb_production', username='root', password=None)[source]

Sets up rubyrep replication via advanced configuration settings yaml.

set_session_timeout(timeout=86400, quiet=True)[source]

Sets the timeout of UI timeout.

Parameters:
  • timeout – Timeout in seconds
  • quiet – Whether to ignore any errors
set_yaml_config(data_dict)[source]
slave_server_name()[source]
slave_server_zone_id()[source]
ssh_client

Creates an ssh client connected to this appliance

Returns: A configured :py:class:utils.ssh.SSHClient instance.

Usage:

with appliance.ssh_client as ssh:
    status, output = ssh.run_command('...')

Note

The credentials default to those found under ssh key in credentials.yaml.

ssh_client_with_privatekey()[source]
start_evm_service(*args, **kwargs)
swap

Retrieves the value of swap for the appliance. Might raise an exception if SSH fails.

Returns:An integer value of swap in the VM in megabytes. If None is returned, it means it was not possible to parse the command output.
Raises:paramiko.ssh_exception.SSHException or socket.error
ui_port
uninstall_vddk(*args, **kwargs)
unregister()[source]

unregisters appliance from RHSM/SAT6

update_guid(*args, **kwargs)
update_rhel(*args, **kwargs)
update_server_roles(changed_roles)[source]
url
use_dev_branch(*args, **kwargs)
user
utc_time()[source]
version
wait_for_embedded_ansible(timeout=900)[source]

Waits for embedded ansible to be ready

Parameters:timeout – Number of seconds to wait until timeout (default 900)
wait_for_evm_service(*args, **kwargs)
wait_for_host_address()[source]
wait_for_miq_server_workers_started(evm_tail=None, poll_interval=5)[source]

Waits for the CFME’s workers to be started by tailing evm.log for: ‘INFO – : MIQ(MiqServer#wait_for_started_workers) All workers have been started’

wait_for_ssh(timeout=600)[source]

Waits for appliance SSH connection to be ready

Parameters:timeout – Number of seconds to wait until timeout (default 600)
wait_for_web_ui(*args, **kwargs)
workaround_missing_gemfile(*args, **kwargs)
write_repofile(repo_id, repo_url, **kwargs)[source]

Wrapper around writing a repofile. You can specify conf options in kwargs.

zone_description
class utils.appliance.MiqApi(entry_point, auth, logger=None, verify_ssl=True, ca_bundle_path=None)[source]

Bases: manageiq_client.api.ManageIQClient

get_entity_by_href(href)[source]

Parses the collections

class utils.appliance.Navigatable(*args, **kwargs)[source]

Bases: utils.appliance.NavigatableMixin

appliance = IPAppliance(address='10.11.12.13', container=None, db_host=None, db_port=5432, ssh_port=22)
class utils.appliance.NavigatableMixin[source]

Bases: object

browser
create_view(view_class, o=None, override=None)[source]
utils.appliance.get_or_create_current_appliance()[source]
utils.appliance.load_appliances(appliance_list, global_kwargs)[source]

Instantiate a list of appliances from configuration data.

Parameters:
  • appliance_list – List of dictionaries that contain parameters for IPAppliance
  • global_kwargs – Arguments that will be defined for each appliances. Appliance can override.
Result:
List of IPAppliance
utils.appliance.load_appliances_from_config(config)[source]

Backwards-compatible config loader.

The config contains some global values and appliances key which contains a list of dicts that have the same keys as IPAppliance.CONFIG_MAPPING‘s keys. If appliances key is not present, it is assumed it is old-format definition and the whole dict is used as a reference for one single appliance.

The global values in the root of the dict (in case of appliances present) have lesser priority than the values in appliance definitions themselves

Parameters:config – A dictionary with the configuration
utils.appliance.provision_appliance(version=None, vm_name_prefix='cfme', template=None, provider_name=None, vm_name=None)[source]

Provisions fresh, unconfigured appliance of a specific version

Note

Version must be mapped to template name under appliance_provisioning > versions in cfme_data.yaml. If no matching template for given version is found, and trackerbot is set up, the latest available template of the same stream will be used. E.g.: if there is no template for 5.5.5.1 but there is 5.5.5.3, it will be used instead. If both template name and version are specified, template name takes priority.

Parameters:
  • version – version of appliance to provision
  • vm_name_prefix – name prefix to use when deploying the appliance vm

Returns: Unconfigured appliance; instance of Appliance

Usage:

my_appliance = provision_appliance('5.5.1.8', 'my_tests')
my_appliance.fix_ntp_clock()
...other configuration...
my_appliance.db.enable_internal()
my_appliance.wait_for_web_ui()
or
my_appliance = provision_appliance('5.5.1.8', 'my_tests')
my_appliance.configure()
utils.mgmt_system package
Module contents

Submodules

utils.ansible module
utils.apidoc module

Sphinx plugin for automatically generating (and optionally cleaning) project api documentation

To enable the optional cleaning, set clean_autogenerated_docs to True in docs/conf.py

utils.apidoc.modules_to_document = ['cfme', 'fixtures', 'markers', 'utils']

List of modules/packages to document, paths relative to the project root.

utils.apidoc.purge_module_apidoc(sphinx, exception)[source]
utils.apidoc.setup(sphinx)[source]

Main sphinx entry point, calls sphinx-apidoc

utils.blockers module
class utils.blockers.BZ(bug_id, **kwargs)[source]

Bases: utils.blockers.Blocker

blocks
bugzilla_bug
data
get_bug_url()[source]
url
class utils.blockers.Blocker(**kwargs)[source]

Bases: object

Base class for all blockers

REQUIRED THING! Any subclass’ constructors must accept kwargs and after POPping the values required for the blocker’s operation, call to ``super` with **kwargs must be done! Failing to do this will render some of the functionality disabled ;).

classmethod all_blocker_engines()[source]

Return mapping of name:class of all the blocker engines in this module.

Having this as a separate function will later enable to scatter the engines across modules in case of extraction into a separate library.

blocks = False
kwargs = {}
classmethod parse(blocker, **kwargs)[source]

Create a blocker object from some representation

url
class utils.blockers.GH(description, **kwargs)[source]

Bases: utils.blockers.Blocker

DEFAULT_REPOSITORY = 'foo/bar'
blocks
data
github = <github.MainClass.Github object>
repo
url
utils.browser module

Core functionality for starting, restarting, and stopping a selenium browser.

class utils.browser.BrowserFactory(webdriver_class, browser_kwargs)[source]

Bases: object

close(browser)[source]
create(url_key)[source]
processed_browser_args()[source]
class utils.browser.BrowserManager(browser_factory)[source]

Bases: object

add_cleanup(callback)[source]
coerce_url_key(key)[source]
ensure_open(url_key=None)[source]
classmethod from_conf(browser_conf)[source]
open_fresh(url_key=None)[source]
quit()[source]
start(url_key=None)[source]
class utils.browser.Wharf(wharf_url)[source]

Bases: object

checkin()[source]
checkout()[source]
docker_id = None
class utils.browser.WharfFactory(webdriver_class, browser_kwargs, wharf)[source]

Bases: utils.browser.BrowserFactory

close(browser)[source]
create(url_key)[source]
processed_browser_args()[source]
class utils.browser.WithZoom(level)[source]

Bases: object

This class is a decorator that used to wrap function with zoom level. this class perform zoom by <level>, call the target function and exit by zooming back to the original zoom level.

Parameters:level (*) – int, the zooming value (i.e. -2 -> 2 clicks out; 3 -> 3 clicks in)
utils.browser.browser()[source]

callable that will always return the current browser instance

If None, no browser is running.

Returns:The current browser instance.
utils.browser.ensure_browser_open(url_key=None)[source]

Ensures that there is a browser instance currently open

Will reuse an existing browser or start a new one as-needed

Returns:The current browser instance.
utils.browser.quit()[source]

Close the current browser

Will silently fail if the current browser can’t be closed for any reason.

Note

If a browser can’t be closed, it’s usually because it has already been closed elsewhere.

utils.browser.start(url_key=None)[source]

Starts a new web browser

If a previous browser was open, it will be closed before starting the new browser

Args:

utils.bz module
class utils.bz.BugWrapper(bugzilla, bug)[source]

Bases: object

__getattr__(attr)[source]

This proxies the attribute queries to the Bug object and modifies its result.

If the field looked up is specified as loose field, it will be converted to Version. If the field is string and it has zero length, or the value is specified as “not specified”, it will return None.

bugzilla
can_test_on_upstream
copies

Returns list of copies of this bug.

copy_of

Returns either id of the bug this is copy of, or None, if it is not a copy.

is_opened
loose
product
qa_whiteboard

Returns a set of QA Whiteboard markers.

It relies on the fact, that our QA Whiteboard uses format foo:bar:baz.

Should be able to handle cases like ‘foo::bar’, or ‘abc:’.

release_flag
upstream_bug
zstream
class utils.bz.Bugzilla(**kwargs)[source]

Bases: object

bug_count
bugs
bugzilla
default_product
classmethod from_config()[source]
get_bug(id)[source]
get_bug_variants(id)[source]
loose
open_states
product(product)[source]
products(*names)[source]
resolve_blocker(blocker, version=None, ignore_bugs=None, force_block_streams=None)[source]
upstream_version
class utils.bz.Product(data)[source]

Bases: object

default_release
latest_version
milestones
name
releases
versions
utils.bz.check_fixed_in(fixed_in, version_series)[source]
utils.category module

Module used for handling categories of let’s say form values and for categorizing them.

class utils.category.CategoryBase(value)[source]

Bases: object

Base class for categories

Parameters:value – Value to be categorized.
utils.category.categorize(iterable, cat)[source]

Function taking iterable of values and a dictionary of rules to categorize the values.

Keys of the dictionary are callables, taking one parameter - the current iterable item. If the call on it returns positive, then the value part of dictionary is taken (assumed callable) and it is called with the current item.

Parameters:
  • iterable – Iterable to categorize.
  • cat – Category specification dictionary
utils.conf module

a wrapper that provides the old :code:utils.conf api

utils.conf.__format__()

default object formatter

utils.conf.__new__(S, ...) → a new object with type S, a subtype of T
utils.conf.__reduce__()

helper for pickle

utils.conf.__reduce_ex__()

helper for pickle

utils.conf.__sizeof__() → int

size of object in memory, in bytes

utils.conf.__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

utils.datafile module

datafile functions, to help reliably datafiles from the data directory.

utils.datafile.data_path_for_filename(filename, base_path, testmod_path=None)[source]

Returns the data path for a given file name

utils.datafile.load_data_file(filename, replacements=None)[source]

Opens the given filename, returning a file object

Parameters:
  • filename – If a base_path string is passed, filename will be loaded from there
  • replacements – If a replacements mapping is passed, the loaded file is assumed to be a template. In this case the replacements mapping will be used in that template’s subsitute method.

Returns: A file object.

utils.db module
class utils.db.Db(hostname=None, credentials=None, port=None)[source]

Bases: _abcoll.Mapping

Helper class for interacting with a CFME database using SQLAlchemy

Parameters:
  • hostname – base url to be used (default is from current_appliance)
  • credentials – name of credentials to use from utils.conf.credentials (default database)

Provides convient attributes to common sqlalchemy objects related to this DB, as well as a Mapping interface to access and reflect database tables. Where possible, attributes are cached.

Db objects support getting tables by name via the mapping interface:

table = db['table_name']

Usage:

# Usually used to query the DB for info, here's a common query
for vm in db.session.query(db['vms']).all():
    print(vm.name)
    print(vm.guid)

# List comprehension to get all templates
[(vm.name, vm.guid) for vm in session.query(db['vms']).all() if vm.template is True]

# Use the transaction manager for write operations:
with db.transaction:
    db.session.query(db['vms']).all().delete()

Note

Creating a table object requires a call to the database so that SQLAlchemy can do reflection to determine the table’s structure (columns, keys, indices, etc). On a latent connection, this can be extremely slow, which will affect methods that return tables, like the mapping interface or values().

__contains__(table_name)[source]

Whether or not the named table is in this db

__eq__(other)[source]

Check if this db is equal to another db

__getitem__(table_name)[source]

Access tables as items contained in this db

Usage:

# To get a table called 'table_name':
db['table_name']

This may return None in the case where a table is found but reflection fails.

__iter__()[source]

Iterator of table names in this db

__len__()[source]

Number of tables in this db

__ne__(other)[source]

Check if this db is not equal to another db

copy()[source]

Copy this database instance, keeping the same credentials and hostname

db_url

The connection URL for this database, including credentials

engine

The Engine for this database

It uses pessimistic disconnection handling, checking that the database is still connected before executing commands.

get(table_name, default=None)[source]

table getter

Parameters:
  • table_name – Name of the table to get
  • default – Default value to return if table_name is not found.

Returns: a table if table_name exists, otherwise ‘None’ or the passed-in default

items()[source]

Iterator of (table_name, table) pairs

keys()[source]

Iterator of table names in this db

metadata

MetaData for this database

This can be used for introspection of reflected items.

Note

Tables that haven’t been reflected won’t show up in metadata. To reflect a table, use reflect_table().

reflect_table(table_name)[source]

Populate metadata with information on a table

Parameters:table_name – The name of a table to reflect
session

Returns a Session

This is used for database queries. For writing to the database, start a transaction().

Note

This attribute is cached. In cases where a new session needs to be explicitly created, use sessionmaker().

sessionmaker

A sessionmaker

Used to make new sessions with this database, as needed.

table_base

Base class for all tables returned by this database

This base class is created using declarative_base.

table_names

A sorted list of table names available in this database.

transaction

Context manager for simple transaction management

Sessions understand the concept of transactions, and provider context managers to handle conditionally committing or rolling back transactions as needed.

Note

Sessions automatically commit transactions by default. For predictable results when writing to the database, use the transaction manager.

Usage:

with db.transaction:
    db.session.do_something()
values()[source]

Iterator of tables in this db

utils.db.database_on_server(*args, **kwds)[source]
utils.db.ping_connection(dbapi_connection, connection_record, connection_proxy)[source]

ping_connection event hook, used to reconnect db sessions that time out

Note

See also: Connection Invalidation

utils.deprecation module
utils.error module

Handles errors based on something beyond the type. You can match error messages with regular expressions. You can also extend the matching behavior however you like. By default, strings are treated as regex and matched against the message of the error. Functions are passed the error and if the function returns ‘truthy’, then the error is caught.

Usage:

from utils import error
with error.expected('foo'):
    x = 1
    raise Exception('oh noes foo happened!')  # this will be caught because regex matches

with error.expected('foo'):
    raise Exception('oh noes bar happened!')  # this will bubble up because it doesn't match

with error.expected('foo'):
    pass  # an error will be thrown because we expected an error but there wasn't one.
exception utils.error.UnexpectedSuccessException[source]

Bases: exceptions.Exception

An error that is thrown when something we expected to fail didn’t fail.

utils.error.expected(*args, **kwds)[source]

Inverts error handling. If the enclosed block doesn’t raise an error, it will raise one. If it raises a matching error, it will return normally. If it raises a non-matching error, that error will be allowed to propagate up the stack.

utils.error.handler(*args, **kwds)[source]

Handles errors based on more than just their type. Any matching error will be caught, the rest will be allowed to propagate up the stack.

utils.error.regex(expr, e)[source]

Search the message of the exception using the regex expr

utils.events module

Library for event testing.

class utils.events.Event(event_tool, *args)[source]

Bases: object

represents either db event received by CFME and stored in event_streams or an expected event

add_attrs(*attrs)[source]

event consists of attributes like event_type, etc. this method allows to add an attribute to event

build_from_raw_event(evt)[source]

helper method which takes raw event from event_streams and prepares event object

matches(evt)[source]

compares current event with passed event.

class utils.events.EventAttr(attr_type=None, cmp_func=None, **attrs)[source]

Bases: object

contains one event attribute and the method for comparing it.

match(attr)[source]

compares current attribute with passed attribute

class utils.events.EventListener(appliance)[source]

Bases: threading.Thread

accepts “expected” events, listens to db events and compares showed up events with expected events. Runs callback function if expected events have it.

__call__(*args, **kwargs)[source]

it is called by register_event fixture. bad idea, to replace register_event by object later

check_expected_events()[source]
get_next_portion()[source]
got_events

returns dict with expected events and all the events matched to expected ones

listen_to(*evts, **kwargs)[source]

accepts one or many events callback function will be called when event arrived in event_streams. callback will receive expected event and got event as params.

Parameters:
  • evts – list of events which EventListener should listen to
  • callback – callback function that will be called if event is received
  • first_event – EventListener waits for only first event of such type. it ignores such event in future if first matching event is found.

By default EventListener collects and receives all matching events.

new_event(*attrs, **kwattrs)[source]

this method just simplifies “expected” event creation.

Usage:

listener = appliance.event_listener()
evt = listener.new_event(target_type='VmOrTemplate',
                        target_name='my_lovely_vm',
                        event_type='vm_create')
listener.listen_to(evt)
process_events()[source]

processes all new db events and compares them with expected events. processed events are ignored next time

reset_events()[source]
reset_matches()[source]
run()[source]
set_last_record(evt=None)[source]
start()[source]
started
stop()[source]
class utils.events.EventTool(appliance)[source]

Bases: object

EventTool serves as a wrapper to getting the events from the database.

Variables:OBJECT_TABLE – Mapping of object types to tables and column names.
OBJECT_TABLE = {'Host': ('hosts', 'name', 'id'), 'Service': ('services', 'name', 'id'), 'VmOrTemplate': ('vms', 'name', 'id')}
all_event_types

Returns a list of all possible events that can be used.

Returns:A list of str.
ensure_event_happens(*args, **kwds)[source]

Context manager usable for one-off checking of the events.

See also: query_miq_events()

Parameters:
  • target_type – What kind of object is the target of the event (MiqServer, VmOrTemplate)
  • target_id – What is the ID of the object (or name, see process_id()).
  • event_type – Type of the event. Ideally one of the all_event_types() but other kinds of events exist too.
event_streams

event_streams table.

event_streams_attributes

event_streams columns and python’s column types

miq_event_definitions

miq_event_definitions table.

process_id(target_type, target_name)[source]

Resolves id, let it be a string or an id.

In case the target_type is defined in the OBJECT_TABLE, you can pass a string with object’s name, otherwise a numeric id to the table is required.

Parameters:
  • target_type – What kind of object is the target of the event (MiqServer, VmOrTemplate...)
  • target_name – An id or a name of the object.
Returns:

int with id of the object in the database.
query(*args, **kwargs)[source]

Wrapper for the SQLAlchemy query method.

query_miq_events(target_type=None, target_id=None, event_type=None, since=None, until=None, from_id=None)[source]

Checks whether an event occured.

Parameters:
  • target_type – What kind of object is the target of the event (MiqServer, VmOrTemplate)
  • target_id – What is the ID of the object (or name, see process_id()).
  • event_type – Type of the event. Ideally one of the all_event_types() but other kinds of events exist too.
  • since – Since when you want to check it. UTC
  • until – Until what time you want to check it.
utils.ext_auth module
utils.ext_auth.disable_external_auth(auth_mode)[source]
utils.ext_auth.disable_external_auth_ipa()[source]

Unconfigure external auth.

utils.ext_auth.disable_external_auth_openldap()[source]
utils.ext_auth.setup_external_auth_ipa(**data)[source]

Sets up the appliance for an external authentication with IPA.

Keywords:
get_groups: Get User Groups from External Authentication (httpd). ipaserver: IPA server address. iparealm: Realm. credentials: Key of the credential in credentials.yaml
utils.ext_auth.setup_external_auth_openldap(**data)[source]

Sets up the appliance for an external authentication with OpenLdap.

Keywords:
get_groups: Get User Groups from External Authentication (httpd). ipaserver: IPA server address. iparealm: Realm. credentials: Key of the credential in credentials.yaml
utils.ftp module

FTP manipulation library

@author: Milan Falešník <mfalesni@redhat.com>

class utils.ftp.FTPClient(host, login, password, upload_dir='/')[source]

Bases: object

FTP Client encapsulation

This class provides basic encapsulation around ftplib’s FTP class. It wraps some methods and allows to easily delete whole directory or walk through the directory tree.

Usage:

>>> from utils.ftp import FTPClient
>>> ftp = FTPClient("host", "user", "password")
>>> only_files_with_EVM_in_name = ftp.filesystem.search("EVM", directories=False)
>>> only_files_by_regexp = ftp.filesystem.search(re.compile("regexp"), directories=False)
>>> some_directory = ftp.filesystem.cd("a/b/c") # cd's to this directory
>>> root = some_directory.cd("/")

Always going through filesystem property is a bit slow as it parses the structure on each use. If you are sure that the structure will remain intact between uses, you can do as follows to save the time:

>>> fs = ftp.filesystem

Let’s download some files:

>>> for f in ftp.filesystem.search("IMPORTANT_FILE", directories=False):
...     f.download()    # To pickup its original name
...     f.download("custom_name")

We finished the testing, so we don’t need the content of the directory:

>>> ftp.recursively_delete()

And it’s gone.

__enter__()[source]

Entering the context does nothing, because the client is already connected

__exit__(type, value, traceback)[source]

Exiting the context means just calling .close() on the client.

cdup()[source]

Goes one level up in directory hierarchy (cd ..)

close()[source]

Finish work and close connection

connect()[source]
cwd(d)[source]

Enter a directory

Parameters:d – Directory name
Returns:Success of the action
dele(f)[source]

Remove a file

Parameters:f – File name
Returns:Success of the action
filesystem

Returns the object structure of the filesystem

Returns:Root directory
ls()[source]

Lists the content of a directory.

Returns:List of all items in current directory Return format is [(is_dir?, “name”, remote_time), ...]
mkd(d)[source]

Create a directory

Parameters:d – Directory name
Returns:Success of the action
pwd()[source]

Get current directory

Returns:Current directory
Raises:AssertionError – PWD command fails
recursively_delete(d=None)[source]

Recursively deletes content of pwd

WARNING: Destructive!

Parameters:
  • d – Directory to enter (None for not entering - root directory)
  • d – str or None
Raises:

AssertionError – When some of the FTP commands fail.
retrbinary(f, callback)[source]

Download file

You need to specify the callback function, which accepts one parameter (data), to be processed.

Parameters:
  • f – Requested file name
  • callback – Callable with one parameter accepting the data
rmd(d)[source]

Remove a directory

Parameters:d – Directory name
Returns:Success of the action
storbinary(f, file_obj)[source]

Store file

You need to specify the file object.

Parameters:
  • f – Requested file name
  • file_obj – File object to be stored
tree(d=None)[source]

Walks the tree recursively and creates a tree

Base structure is a list. List contains directory content and the type decides whether it’s a directory or a file: - tuple: it’s a file, therefore it represents file’s name and time - dict: it’s a directory. Then the dict structure is as follows:

dir: directory name
content: list of directory content (recurse)
Parameters:d – Directory to enter(None for no entering - root directory)
Returns:Directory structure in lists nad dicts.
Raises:AssertionError – When some of the FTP commands fail.
update_time_difference()[source]

Determine the time difference between the FTP server and this computer.

This is done by uploading a fake file, reading its time and deleting it. Then the self.dt variable captures the time you need to ADD to the remote time or SUBTRACT from local time.

The FTPFile object carries this automatically as it has .local_time property which adds the client’s .dt to its time.

class utils.ftp.FTPDirectory(client, name, items, parent_dir=None, time=None)[source]

Bases: object

FTP FS Directory encapsulation

This class represents one directory. Contains pointers to all child directories (self.directories) and also all files in current directory (self.files)

cd(path)[source]

Change to a directory

Changes directory to a path specified by parameter path. There are three special cases: / - climbs by self.parent_dir up in the hierarchy until it reaches root element. . - does nothing .. - climbs one level up in hierarchy, if present, otherwise does the same as preceeding.

Parameters:path – Path to change
path
Returns:whole path for this directory
search(by, files=True, directories=True)[source]

Recursive search by string or regexp.

Searches throughout all the filesystem structure from top till the bottom until it finds required files or dirctories. You can specify either plain string or regexp. String search does classic in, regexp matching is done by exact matching (by.match).

Parameters:
  • by – Search string or regexp
  • files – Whether look for files
  • directories – Whether look for directories
Returns:

List of all objects found in FS
exception utils.ftp.FTPException[source]

Bases: exceptions.Exception

class utils.ftp.FTPFile(client, name, parent_dir, time)[source]

Bases: object

FTP FS File encapsulation

This class represents one file in the FS hierarchy. It encapsulates mainly its position in FS and adds the possibility of downloading the file.

download(target=None)[source]

Download file into this machine

Wrapper around self.retr function. It downloads the file from remote filesystem into local filesystem. Name is either preserved original, or can be changed.

Parameters:target – Target file name (None to preserver the original)
local_time
Returns:time modified to match local computer’s time zone
path
Returns:whole path for this file
retr(callback)[source]

Retrieve file

Wrapper around ftplib.FTP.retrbinary(). This function cd’s to the directory where this file is present, then calls the FTP’s retrbinary() function with provided callable and then cd’s back where it started to keep it consistent.

Parameters:

callback – Any callable that accepts one parameter as the data
Raises:
  • AssertionError – When any of the CWD or CDUP commands fail.
  • ftplib.error_perm – When retrbinary call of ftplib fails
utils.generators module
utils.generators.random_vm_name(context=None, max_length=15)[source]

Generates a valid VM name that should be valid for any provider we use.

Constraints:
  • Maximum string length 15 characters (by default)
  • Only [a-z0-9-]
Parameters:context – If you want to provide some custom string after test- instead of vm. It is recommended to use a maximum of 5 characters with the default 15 character limit. Longer strings will be truncated
Returns:A valid randomized VM name.
utils.grafana module

Wrap interactions with Grafana or logging Grafana URLs.

utils.grafana.get_scenario_dashboard_urls(scenario, from_ts, to_ts, output_to_log=True)[source]

Builds a dictionary of URLs to Grafana Dashboards of relevant appliances for a single workload’s scenario. It accounts for when a replication_master appliance is under test too.

utils.hosts module
utils.hosts
utils.hosts.get_host_data_by_name(provider_key, host_name)[source]
utils.hosts.setup_all_provider_hosts_credentials()[source]
utils.hosts.setup_host_creds(provider_key, host_name, remove_creds=False, ignore_errors=False)[source]
utils.hosts.setup_providers_hosts_credentials(provider_key, ignore_errors=False)[source]
utils.ipmi module
class utils.ipmi.IPMI(hostname, username, password, interface_type='lan', timeout=30)[source]

Utility to access IPMI via CLI.

The IPMI utility uses the ipmitool package to access the remote management card of a server.

Parameters:
  • hostname – The hostname of the remote management console.
  • username – The username for the remote management console.
  • password – The password tied to the username.
  • interface_type – A string giving the interface_type to pass to the CLI.
  • timeout – The number of seconds to wait before giving up on a command.

Returns: A IPMI instnace.

is_power_on()[source]

Checks if the power is on.

Returns: True if power is on, False if not.

power_off()[source]

Turns the power off.

Returns: True if power is off, False if not.

power_on()[source]

Turns the power on.

Returns: True if power is on, False if not.

power_reset()[source]

Turns the power off.

Returns: True if power reset initiated, False if not.

exception utils.ipmi.IPMIException[source]

Bases: exceptions.Exception

Raised during _run_ipmi() if the error code is non zero.

utils.log module

Logging framework

This module creates the cfme logger, for use throughout the project. This logger only captures log messages explicitly sent to it, not logs emitted by other components (such as selenium). To capture those, consider using the pytest-capturelog plugin.

Example Usage
from utils.log import logger

logger.debug('debug log message')
logger.info('info log message')
logger.warning('warning log message')
logger.error('error log message')
logger.critical('critical log message')

The above will result in the following output in cfme_tests/logs/cfme.log:

1970-01-01 00:00:00,000 [D] debug log message (filename.py:3)
1970-01-01 00:00:00,000 [I] info log message (filename.py:4)
1970-01-01 00:00:00,000 [W] warning log message (filename.py:5)
1970-01-01 00:00:00,000 [E] error log message (filename.py:6)
1970-01-01 00:00:00,000 [C] fatal log message (filename.py:7)

Additionally, if log_error_to_console is True (see below), the following will be written to stderr:

[E] error (filename.py:6)
[C] fatal (filename.py:7)
Log Message Source

We have added a custom log record attribute that can be used in log messages: %(source)s This attribute is included in the default ‘cfme’ logger configuration.

This attribute will be generated by default and include the filename and line number from where the log message was emitted. It will attempt to convert file paths to be relative to cfme_tests, but use the absolute file path if a relative path can’t be determined.

When writting generic logging facilities, it is sometimes helpful to override those source locations to make the resultant log message more useful. To do so, pass the extra source_file (str) and source_lineno (int) to the log emission:

logger.info('info log message', extra={'source_file': 'somefilename.py', 'source_lineno': 7})

If source_lineno is None and source_file is included, the line number will be omitted. This is useful in cases where the line number can’t be determined or isn’t necessary.

Configuration
# in env.yaml
logging:
    # Can be one of DEBUG, INFO, WARNING, ERROR, CRITICAL
    level: INFO
    # Maximum logfile size, in bytes, before starting a new logfile
    # Set to 0 to disable log rotation
    max_logfile_size: 0
    # Maximimum backup copies to make of rotated log files (e.g. cfme.log.1, cfme.log.2, ...)
    # Set to 0 to keep no backups
    max_logfile_backups: 0
    # If True, messages of level ERROR and CRITICAL are also written to stderr
    errors_to_console: False
    # Default file format
    file_format: "%(asctime)-15s [%(levelname).1s] %(message)s (%(source)s)"
    # Default format to console if errors_to_console is True
    stream_format: "[%(levelname)s] %(message)s (%(source)s)"

Additionally, individual logger configurations can be overridden by defining nested configuration values using the logger name as the configuration key. Note that the name of the logger objects exposed by this module don’t obviously line up with their key in cfme_data. The ‘name’ attribute of loggers can be inspected to get this value:

>>> utils.log.logger.name
'cfme'
>>> utils.log.perflog.logger.name
'perf'

Here’s an example of those names being used in env.local.yaml to configure loggers individually:

logging:
    cfme:
        # set the cfme log level to debug
        level: DEBUG
    perf:
        # make the perflog a little more "to the point"
        file_format: "%(message)s"

Notes:

  • The cfme and perf loggers are guaranteed to exist when using this module.
  • The name of a logger is used to generate its filename, and will usually not have the word “log” in it.
    • perflog‘s logger name is perf for this reason, resulting in log/perf.log instead of log/perflog.log.
    • Similarly, logger‘s’ name is cfme, to prevent having log/logger.log.

Warning

Creating a logger with the same name as one of the default configuration keys, e.g. create_logger('level') will cause a rift in space-time (or a ValueError).

Do not attempt.

Message Format
year-month-day hour:minute:second,millisecond [Level] message text (file:linenumber)

[Level]:

One letter in square brackets, where [I] corresponds to INFO, [D] corresponds to DEBUG, and so on.

(file:linenumber):

The relative location from which this log message was emitted. Paths outside
Members
class utils.log.ArtifactorHandler(level=0)[source]

Bases: logging.Handler

Logger handler that hands messages off to the artifactor

artifactor = None
emit(record)[source]
slaveid = None
class utils.log.NamedLoggerAdapter(logger, extra)[source]

Bases: utils.log.TraceLoggerAdapter

An adapter that injects a name into log messages

process(message, kwargs)[source]
class utils.log.Perflog(perflog_name='perf')[source]

Bases: object

Performance logger, useful for timing arbitrary events by name

Logged events will be written to log/perf.log by default, unless a different log file name is passed to the Perflog initializer.

Usage:

from utils.log import perflog
perflog.start('event_name')
# do stuff
seconds_taken = perflog.stop('event_name')
# seconds_taken is also written to perf.log for later analysis
start(event_name)[source]

Start tracking the named event

Will reset the start time if the event is already being tracked

stop(event_name)[source]

Stop tracking the named event

Returns:A float value of the time passed since start was last called, in seconds, or None if start was never called.
tracking_events = {}
class utils.log.PrefixAddingLoggerFilter(prefix=None)[source]

Bases: logging.Filter

filter(record)[source]
class utils.log.TraceLogger(name, level=0)[source]

Bases: logging.Logger

A trace-loglevel-aware Logger

trace(msg, *args, **kwargs)[source]

Log ‘msg % args’ with severity ‘TRACE’.

class utils.log.TraceLoggerAdapter(logger, extra)[source]

Bases: logging.LoggerAdapter

A trace-loglevel-aware LoggerAdapter

trace(msg, *args, **kwargs)[source]

Delegate a trace call to the underlying logger, after adding contextual information from this adapter instance.

class utils.log.WarningsDeduplicationFilter[source]

Bases: object

this filter is needed since something in the codebase causes the warnings once filter to be reset, so we need to deduplicate on our own

there is no indicative codepath that is clearly at fault so this low implementation cost solution was choosen to deduplicate off-band

filter(record)[source]
class utils.log.WarningsRelpathFilter(name='')[source]

Bases: logging.Filter

filter to modify warnings messages, to use relative paths in the project

filter(record)[source]
utils.log.add_stdout_handler(logger)[source]

Look for a stdout handler in the logger, add one if not present

utils.log.create_sublogger(logger_sub_name)[source]
utils.log.error_console_handler()[source]
utils.log.format_marker(mstring, mark='-')[source]

Creates a marker in log files using a string and leader mark.

This function uses the constant MARKER_LEN to determine the length of the marker, and then centers the message string between padding made up of leader_mark characters.

Parameters:
  • mstring – The message string to be placed in the marker.
  • leader_mark – The marker character to use for leading and trailing.

Returns: The formatted marker string.

Note: If the message string is too long to fit one character of leader/trailer and
a space, then the message is returned as is.
class utils.log.logger_wrap(*args, **kwargs)[source]

Bases: object

Sets up the logger by default, used as a decorator in utils.appliance

If the logger doesn’t exist, sets up a sensible alternative

utils.log.make_file_handler(filename, root='/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/log', level=None, **kw)[source]
utils.log.nth_frame_info(n)[source]

Inspect the stack to determine the filename and lineno of the code running at the “n”th frame

Parameters:n – Number of the stack frame to inspect

Raises IndexError if the stack doesn’t contain the nth frame (the caller should know this)

Returns a frameinfo namedtuple as described in inspect

utils.log.setup_for_worker(workername, loggers=('cfme', 'py.warnings'))[source]
utils.log.setup_logger(logger)[source]
utils.log_validator module
class utils.log_validator.LogValidator(remote_filename, **kwargs)[source]

Bases: object

Log content validator class provides methods to fix the log content before test is started, and validate the content of log during test execution, according to predefined patterns. Predefined patterns are:

  • Logs which should be skipped. Skip further checks on particular line if matched
  • Logs which should cause failure of test.
  • Logs which are expected to be matched, otherwise fail.

The priority of patterns to be checked are defined in above order. Skipping patterns have priority over other ones, to be possible to skip particular ERROR log, but fail for wider range of other ERRORs.

Parameters:
  • remote_filename – path to the remote log file
  • skip_patterns – array of skip regex patterns
  • failure_patterns – array of failure regex patterns
  • matched_patterns – array of expected regex patterns to be matched

Usage:

.. code-block:: python
  evm_tail = LogValidator('/var/www/miq/vmdb/log/evm.log',
                          skip_patterns=['PARTICULAR_ERROR'],
                          failure_patterns=['.*ERROR.*'],
                          matched_patterns=['PARTICULAR_INFO'])
  evm_tail.fix_before_start()
  evm_tail.validate_logs()
fix_before_start()[source]
validate_logs()[source]
utils.net module
utils.net.ip_echo_socket(port=32123)[source]

A simple socket server, for use with my_ip_address()

utils.net.is_pingable(ip_addr)[source]

verifies the specified ip_address is reachable or not.

Parameters:ip_addr – ip_address to verify the PING.

returns: return True is ip_address is pinging else returns False.

utils.net.my_ip_address(http=False)[source]

Get the ip address of the host running tests using the service listed in cfme_data[‘ip_echo’]

The ip echo endpoint is expected to write the ip address to the socket and close the connection. See a working example of this in ip_echo_socket().

utils.net.net_check(port, addr=None, force=False)[source]

Checks the availablility of a port

utils.net.net_check_remote(port, addr=None, machine_addr=None, ssh_creds=None, force=False)[source]

Checks the availability of a port from outside using another machine (over SSH)

utils.net.random_port(tcp=True)[source]

Get a random port number for making a socket

Parameters:tcp – Return a TCP port number if True, UDP if False

This may not be reliable at all due to an inherent race condition. This works by creating a socket on an ephemeral port, inspecting it to see what port was used, closing it, and returning that port number. In the time between closing the socket and opening a new one, it’s possible for the OS to reopen that port for another purpose.

In practical testing, this race condition did not result in a failure to (re)open the returned port number, making this solution squarely “good enough for now”.

utils.net.resolve_hostname(hostname, force=False)[source]

Cached DNS resolver. If the hostname does not resolve to an IP, returns None.

utils.net.resolve_ips(host_iterable, force_dns=False)[source]

Takes list of hostnames, ips and another things. If the item is not an IP, it will be tried to be converted to an IP. If that succeeds, it is appended to the set together with original hostname. If it can’t be resolved, just the original hostname is appended.

utils.ocp_cli module
class utils.ocp_cli.OcpCli(provider)[source]

Bases: object

This class provides CLI functionality for Openshift provider.

close()[source]
run_command(*args, **kwargs)[source]
utils.path module

Project path helpers

Contains py.path.local objects for accessing common project locations.

Paths rendered below will be different in your local environment.

utils.path.conf_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/conf')

conf yaml storage, cfme_tests/conf/

utils.path.data_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/data')

datafile storage, cfme_tests/data/

utils.path.docs_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/docs')

doc root, where these file came from! cfme_tests/docs/

utils.path.get_rel_path(absolute_path_str)[source]

Get a relative path for object in the project root

Parameters:absolute_path_str – An absolute path to a file anywhere under project_path

Note

This will be a no-op for files that are not in project_path

utils.path.log_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/log')

log storage, cfme_tests/log/

utils.path.middleware_resources_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/data/resources/middleware')

middleware provider resource files path, cfme_tests/data/resources/middleware

utils.path.orchestration_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/data/orchestration')

orchestration datafile storage, cfme_tests/data/orchestration

utils.path.patches_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/data/patches')

patch files (diffs)

utils.path.project_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0')

The project root, cfme_tests/

utils.path.resources_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/data/resources')

resource files root directory, cfme_tests/data/resources

utils.path.results_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/results')

results path for performance tests, cfme_tests/results/

utils.path.scripts_data_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/scripts/data')

interactive scripts’ data, cfme_tests/scripts/data

utils.path.scripts_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/scripts')

interactive scripts, cfme_tests/scripts/

utils.path.template_path = local('/home/docs/checkouts/readthedocs.org/user_builds/cfme-tests/checkouts/17.11.0/data/templates')

jinja2 templates, use with jinja2.FileSystemLoader

utils.perf module

Functions that performance tests use.

utils.perf.collect_log(ssh_client, log_prefix, local_file_name, strip_whitespace=False)[source]

Collects all of the logs associated with a single log prefix (ex. evm or top_output) and combines to single gzip log file. The log file is then scp-ed back to the host.

utils.perf.convert_top_mem_to_mib(top_mem)[source]

Takes a top memory unit from top_output.log and converts it to MiB

utils.perf.generate_statistics(the_list, decimals=2)[source]

Returns comma seperated statistics over a list of numbers.

Returns: list of samples(runs), minimum, average, median, maximum,
stddev, 90th(percentile), 99th(percentile)
utils.perf.get_worker_pid(worker_type)[source]

Obtains the pid of the first worker with the worker_type specified

utils.perf.set_rails_loglevel(level, validate_against_worker='MiqUiWorker')[source]

Sets the logging level for level_rails and detects when change occured.

utils.perf_message_stats module

Functions for performance analysis/charting of the backend messages and top_output from an appliance.

class utils.perf_message_stats.MiqMsgBucket[source]

Bases: object

class utils.perf_message_stats.MiqMsgLists[source]

Bases: object

class utils.perf_message_stats.MiqMsgStat[source]

Bases: object

class utils.perf_message_stats.MiqWorker[source]

Bases: object

utils.perf_message_stats.evm_to_messages(evm_file, filters)[source]
utils.perf_message_stats.evm_to_workers(evm_file)[source]
utils.perf_message_stats.generate_appliance_charts(top_appliance, charts_dir, start_index, end_index)[source]
utils.perf_message_stats.generate_hourly_charts_and_csvs(hourly_buckets, charts_dir)[source]
utils.perf_message_stats.generate_raw_data_csv(rawdata_dict, csv_file_name)[source]
utils.perf_message_stats.generate_total_time_charts(msg_cmds, charts_dir)[source]
utils.perf_message_stats.generate_worker_charts(workers, top_workers, charts_dir)[source]
utils.perf_message_stats.get_first_miqtop(top_log_file)[source]
utils.perf_message_stats.get_msg_args(log_line)[source]
utils.perf_message_stats.get_msg_cmd(log_line)[source]
utils.perf_message_stats.get_msg_del(log_line)[source]
utils.perf_message_stats.get_msg_deq(log_line)[source]
utils.perf_message_stats.get_msg_id(log_line)[source]
utils.perf_message_stats.get_msg_timestamp_pid(log_line)[source]
utils.perf_message_stats.hour_bucket_init(init)[source]
utils.perf_message_stats.line_chart_render(title, xtitle, ytitle, x_labels, lines, fname, stacked=False)[source]
utils.perf_message_stats.messages_to_hourly_buckets(messages, test_start, test_end)[source]
utils.perf_message_stats.messages_to_statistics_csv(messages, statistics_file_name)[source]
utils.perf_message_stats.perf_process_evm(evm_file, top_file)[source]
utils.perf_message_stats.provision_hour_buckets(test_start, test_end, init=True)[source]
utils.perf_message_stats.split_appliance_charts(top_appliance, charts_dir)[source]
utils.perf_message_stats.top_to_appliance(top_file)[source]
utils.perf_message_stats.top_to_workers(workers, top_file)[source]
utils.ports module
utils.ports.__format__()

default object formatter

utils.ports.__new__(S, ...) → a new object with type S, a subtype of T
utils.ports.__reduce__()

helper for pickle

utils.ports.__reduce_ex__()

helper for pickle

utils.ports.__sizeof__() → int

size of object in memory, in bytes

utils.ports.__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

utils.pretty module
class utils.pretty.Pretty[source]

Bases: object

A mixin that prints repr as <MyClass field1=..., field2=...>. The fields that will be printed should be stored in the class’s pretty_attrs attribute (none by default).

pretty_attrs = []
utils.pretty.attr_repr(o, attr)[source]

Return the string repr of the attribute attr on the object o

utils.pretty.pr_obj(attrs)[source]
utils.pretty.pretty_repr(attrs, o)[source]
utils.providers module

Helper functions related to the creation, listing, filtering and destruction of providers

The list_providers function in this module depend on a (by default global) dict of filters. If you are writing tests or fixtures, you want to depend on this function as a de facto gateway.

The rest of the functions, such as get_mgmt, get_crud, get_provider_keys etc ignore this global dict and will provide you with whatever you ask for with no limitations.

The main clue to know what is limited by the filters and what isn’t is the ‘filters’ parameter.

class utils.providers.ProviderFilter(keys=None, classes=None, required_fields=None, required_tags=None, required_flags=None, restrict_version=False, inverted=False, conjunctive=True)[source]

Bases: object

Filter used to obtain only providers matching given requirements

Parameters:
  • keys – List of acceptable provider keys, all if None
  • categories – List of acceptable provider categories, all if None
  • types – List of acceptable provider types, all if None
  • required_fields – List of required fields, see providers_by_class()
  • restrict_version – Checks provider version in yamls if True
  • required_tags – List of tags that must be set in yamls
  • inverted – Inclusive if False, exclusive otherwise
  • conjunctive – If true, all subfilters are applied and all must match (default) If false (disjunctive), at least one of the subfilters must match
__call__(provider)[source]

Applies this filter on a given provider

Usage:

pf = ProviderFilter('cloud_infra', categories=['cloud', 'infra'])
providers = list_providers([pf])
pf2 = ProviderFilter(
    classes=[GCEProvider, EC2Provider], required_fields=['small_template'])
provider_keys = [prov.key for prov in list_providers([pf, pf2])]
^ this will list keys of all GCE and EC2 providers
...or...
pf = ProviderFilter(required_tags=['openstack', 'complete'])
pf_inverted = ProviderFilter(required_tags=['disabled'], inverted=True)
providers = list_providers([pf, pf_inverted])
^ this will return providers that have both the "openstack" and "complete" tags set
  and at the same time don't have the "disabled" tag
...or...
pf = ProviderFilter(keys=['rhevm34'], class=CloudProvider, conjunctive=False)
providers = list_providers([pf])
^ this will list all providers that either have the 'rhevm34' key or are an instance
  of the CloudProvider class and therefore are a cloud provider
Returns:True if provider passed all checks and was not filtered out, False otherwise. The result is opposite if the ‘inverted’ attribute is set to True.
copy()[source]
exception utils.providers.UnknownProvider(provider_key, *args, **kwargs)[source]

Bases: exceptions.Exception

utils.providers.get_class_from_type(prov_type)[source]
utils.providers.get_crud(provider_key, appliance=None)[source]

Creates a Provider object given a management_system key in cfme_data.

Usage:

get_crud('ec2east')

Returns: A Provider object that has methods that operate on CFME

utils.providers.get_crud_by_name(provider_name, appliance=None)[source]

Creates a Provider object given a management_system name in cfme_data.

Usage:

get_crud_by_name('My RHEV 3.6 Provider')

Returns: A Provider object that has methods that operate on CFME

utils.providers.get_mgmt(provider_key, providers=None, credentials=None)[source]

Provides a wrapanapi object, based on the request.

Parameters:
  • provider_key – The name of a provider, as supplied in the yaml configuration files. You can also use the dictionary if you want to pass the provider data directly.
  • providers – A set of data in the same format as the management_systems section in the configuration yamls. If None then the configuration is loaded from the default locations. Expects a dict.
  • credentials – A set of credentials in the same format as the credentials yamls files. If None then credentials are loaded from the default locations. Expects a dict.
Return: A provider instance of the appropriate wrapanapi.WrapanapiAPIBase
subclass
utils.providers.list_provider_keys(provider_type=None)[source]

Lists provider keys from conf (yamls)

Parameters:provider_type – Optional filtering by ‘type’ string (from yaml); disabled by default

Note: Doesn’t require the framework to be pointed at an appliance to succeed.

Returns: List of provider keys (strings).

utils.providers.list_providers(filters=None, use_global_filters=True, appliance=None)[source]

Lists provider crud objects, global filter optional

Parameters:
  • filters – List if ProviderFilter or None
  • use_global_filters – Will apply global filters as well if True, will not otherwise
  • appliance – Optional utils.appliance.IPAppliance to be passed to provider CRUD objects

Note: Requires the framework to be pointed at an appliance to succeed.

Returns: List of provider crud objects.

utils.providers.list_providers_by_class(prov_class, use_global_filters=True, appliance=None)[source]

Lists provider crud objects of a specific class (or its subclasses), global filter optional

Parameters:

Note: Requires the framework to be pointed at an appliance to succeed.

Returns: List of provider crud objects.

utils.providers.load_setuptools_entrypoints()[source]

Load modules from querying the specified setuptools entrypoint name.

utils.pytest_shortcuts module
utils.pytest_shortcuts.extract_fixtures_values(item)[source]

Extracts names and values of all the fixtures that the test has.

Parameters:item – py.test test item
Returns:dict with fixtures and their values.
utils.quote module
utils.quote.quote(*args)[source]

Combine the arguments into a single string and escape any and all shell special characters or (reserved) words. The shortest possible string (correctly quoted suited to pass to a bash shell) is returned.

utils.rest module

Helper functions for tests using REST API.

utils.rest.assert_response(rest_obj, success=None, http_status=None, results_num=None)[source]

Asserts that the response HTTP status code and content is as expected.

utils.rest.get_vms_in_service(rest_api, service)[source]

Gets list of vm entities associated with the service.

utils.smem_memory_monitor module

Monitor Memory on a CFME/Miq appliance and builds report&graphs displaying usage per process.

class utils.smem_memory_monitor.SmemMemoryMonitor(ssh_client, scenario_data)[source]

Bases: threading.Thread

create_process_result(process_results, starttime, process_pid, process_name, memory_by_pid)[source]
get_appliance_memory(appliance_results, plottime)[source]
get_evm_workers()[source]
get_miq_server_id()[source]
get_pids_memory()[source]
run()[source]
utils.smem_memory_monitor.add_workload_quantifiers(quantifiers, scenario_data)[source]
utils.smem_memory_monitor.compile_per_process_results(procs_to_compile, process_results, ts_end)[source]
utils.smem_memory_monitor.create_dict(attr_dict)[source]
utils.smem_memory_monitor.create_report(scenario_data, appliance_results, process_results, use_slab, grafana_urls)[source]
utils.smem_memory_monitor.generate_raw_data_csv(directory, appliance_results, process_results)[source]
utils.smem_memory_monitor.generate_summary_csv(file_name, appliance_results, process_results, provider_names, version_string)[source]
utils.smem_memory_monitor.generate_summary_html(directory, version_string, appliance_results, process_results, scenario_data, provider_names, grafana_urls)[source]
utils.smem_memory_monitor.generate_workload_html(directory, ver, scenario_data, provider_names, grafana_urls)[source]
utils.smem_memory_monitor.get_scenario_html(scenario_data)[source]
utils.smem_memory_monitor.graph_all_miq_workers(graph_file_path, process_results, provider_names)[source]
utils.smem_memory_monitor.graph_appliance_measurements(graphs_path, ver, appliance_results, use_slab, provider_names)[source]
utils.smem_memory_monitor.graph_individual_process_measurements(graph_file_path, process_results, provider_names)[source]
utils.smem_memory_monitor.graph_same_miq_workers(graph_file_path, process_results, provider_names)[source]
utils.smem_memory_monitor.install_smem(ssh_client)[source]
utils.smem_memory_monitor.summary_csv_measurement_dump(csv_file, process_results, measurement)[source]
utils.smtp_collector_client module
class utils.smtp_collector_client.SMTPCollectorClient(host='localhost', port=1026)[source]

Bases: object

Client for smtp_collector.py script

Parameters:
  • host – Host where collector runs (Default: localhost)
  • port – Port where the collector query interface listens (Default: 1026)
clear_database()[source]

Clear the database in collector

Returns: bool

get_emails(**filter)[source]

Get emails. Eventually apply filtering on SQLite level

Time variables can be passed as instances of utils.timeutil.parsetime. That carries out the necessary conversion automatically.

_like args - see SQLite’s LIKE operator syntax

Keywords:
from_address: E-mail matches. to_address: E-mail matches. subject: Subject matches exactly. subject_like: Subject is LIKE. time_from: E-mails arrived since this time. time_to: E-mail arrived before this time. text: Text matches exactly. text_like: Text is LIKE.

Returns: List of dicts with e-mails matching the criteria.

get_html_report()[source]
set_test_name(test_name)[source]

Set the test name for folder name in the collector.

Parameters:test_name – Name to set

Returns: bool with result.

utils.soft_get module
exception utils.soft_get.MultipleResultsException[source]

Bases: exceptions.Exception

utils.soft_get.soft_get(obj, field_base_name, dict_=False, case_sensitive=False, best_match=True, dont_include=None)[source]

This function used for cases that we want to get some attribute that we either know only few parts of its name or want to prevent from case issues.

Example

Imagine you have a relationships table and you want to get ‘image’ field. Since sometimes the exact name of the field is changing among versions, pages, etc. it could be appear as ‘Images’, ‘Image’, ‘Container Images’, Containers Images’, etc. Since we don’t care for the exact name and know that ‘image’ is a unique in the table, we can use this function to prevent from this complexity.

Parameters:
  • obj (*) – The object which we want to get the attribute
  • field_base_name (*) – The base name, a string that we know for sure that is a sub-string of the target field
  • dict (*) – Whether this is a dict AND we want to perform the same functionality on its keys
  • case_sensitive (*) – Whether the search is a sensitive case.
  • best_match (*) –
    If True: in case that it found more than 1 match field,
    it will take the closest one
    If False: in case that it found more than 1 match field,
    it will raise an error
  • dont_include (*) – Strings that should not be a part of the field. Used to prevent cases like: soft_get(obj, ‘image’) -> obj.image_registry
Returns:

The value of the target attribute
utils.ssh module
class utils.ssh.SSHClient(stream_output=False, **connect_kwargs)[source]

Bases: paramiko.client.SSHClient

paramiko.SSHClient wrapper

Allows copying/overriding and use as a context manager Constructor kwargs are handed directly to paramiko.SSHClient.connect()

Parameters:
  • container – If specified, then it is assumed that the VM hosts a container of CFME. The param then contains the name of the container.
  • is_pod – If specified and True, then it is assumed that the target is a podified openshift app and container then specifies the name of the pod to interact with.
  • stdout – If specified, overrides the system stdout file for streaming output.
  • stderr – If specified, overrides the system stderr file for streaming output.
appliance_has_netapp()[source]
client_address()[source]
close()[source]
connect(hostname=None, **kwargs)[source]

See paramiko.SSHClient.connect

connected
cpu_spike(seconds=60, cpus=2, **kwargs)[source]

Creates a CPU spike of specific length and processes.

Parameters:
  • seconds – How long the spike should last.
  • cpus – How many processes to use.
Returns:

See SSHClient.run_command()
get_build_date()[source]
get_build_datetime()[source]
get_file(remote_file, local_path='', **kwargs)[source]
get_transport(*args, **kwargs)[source]
is_appliance_downstream()[source]
is_container
open_sftp(*args, **kwargs)[source]
patch_file(local_path, remote_path, md5=None)[source]

Patches a single file on the appliance

Parameters:
  • local_path – Path to patch (diff) file
  • remote_path – Path to file to be patched (on the appliance)
  • md5 – MD5 checksum of the original file to check if it has changed
Returns:

True if changes were applied, False if patching was not necessary

Note

If there is a .bak file present and the file-to-be-patched was not patched by the current patch-file, it will be used to restore it first. Recompiling assets and restarting appropriate services might be required.

put_file(local_file, remote_file='.', **kwargs)[source]
run_command(command, timeout=1200.0, reraise=False, ensure_host=False, ensure_user=False)[source]

Run a command over SSH.

Parameters:
  • command – The command. Supports taking dicts as version picking.
  • timeout – Timeout after which the command execution fails.
  • reraise – Does not muffle the paramiko exceptions in the log.
  • ensure_host – Ensure that the command is run on the machine with the IP given, not any container or such that we might be using by default.
  • ensure_user – Ensure that the command is run as the user we logged in, so in case we are not root, setting this to True will prevent from running sudo.
Returns:

A SSHResult instance.
run_rails_command(command, timeout=1200.0, **kwargs)[source]
run_rails_console(command, sandbox=False, timeout=1200.0)[source]

Runs Ruby inside of rails console. stderr is thrown away right now but could prove useful for future performance analysis of the queries rails runs. The command is encapsulated by double quotes. Sandbox rolls back all changes made to the database if used.

run_rake_command(command, timeout=1200.0, **kwargs)[source]
status

Parses the output of the systemctl status evmserverd.

Returns:A dictionary containing servers and workers, both lists. Each of the lists contains dictionaries, one per line. You can refer inside the dictionary using the headers.
uptime()[source]
username
class utils.ssh.SSHResult[source]

Bases: utils.ssh.SSHResult

Allows rich comparison for more convenient testing.

Given you have result which is an instance of SSHResult, you can do as follows

assert result  # If $?=0, then the result evaluates to a truthy value and passes the assert
assert result == 'installed'  # direct matching of the output value
assert 'something' in result  # like before but uses the ``in`` matching for a partial match
assert result == 5  # assert that the $?=5 (you can use <, >, ...)

Therefore this class can act like 3 kinds of values

  • Like a string (with the output of the command) when compared with or cast to one
  • Like a number (with the return code) when compared with or cast to one
  • Like a bool, giving truthy value if the return code was zero. That is related to the preceeding bullet.

But it still subclasses the original class therefore all old behaviour is kept. But you don’t have to expand the tuple or pull the value out if you are checking only one of them.

failed
success
class utils.ssh.SSHTail(remote_filename, **connect_kwargs)[source]

Bases: utils.ssh.SSHClient

lines_as_list()[source]

Return lines as list

raw_lines()[source]
raw_string()[source]
set_initial_file_end()[source]
utils.ssh.keygen()[source]

Generate temporary ssh keypair for appliance SSH auth

Intended not only to simplify ssh access to appliances, but also to simplify SSH access from one appliance to another in multi-appliance setups

utils.stats module
utils.stats.tol_check(ref, compare, min_error=0.05, low_val_correction=3.0)[source]

Tolerance check

The tolerance check is very simple. In essence it checks to ensure that the compare value is within min_error percentage of the ref value. However there are special conditions.

If the ref value is zero == the compare value we will alwys return True to avoid calculation overhead.

If the ref value is zero we check if the compare value is below the low_val_correction threshold.

The low value correction is also used if ref is small. In this case, if one minus the difference of the ref and low value correction / reference value yields greater error correction, then this is used.

For example, if the reference was 1 and the compare was 2, with a min_error set to the default, the tolerance check would return False. At low values this is probably undesirable and so, the low_val_correction allows for a greater amount of error at low values. As an example, with the lvc set to 3, the allowe error would be much higher, allowing the tolerance check to pass.

The lvc will only take effect if the error it produces is greater than the min_error.

Parameters:
  • ref – The reference value
  • compare – The comparison value
  • min_error – The minimum allowed error
  • low_val_correction – A correction value for lower values
utils.testgen module

Test generation helpers

Intended to functionalize common tasks when working with the pytest_generate_tests hook.

When running a test, it is quite often the case that multiple parameters need to be passed to a single test. An example of this would be the need to run a Provider Add test against multiple providers. We will assume that the providers are stored in the yaml under a common structure like so:

providers:
    prov_1:
        name: test
        ip: 10.0.0.1
        test_vm: abc1
    prov_2:
        name: test2
        ip: 10.0.0.2
        test_vm: abc2

Our test requires that we have a Provider Object and as an example, the ‘test_vm’ field of the object. Let’s assume a test prototype like so:

test_provider_add(provider_obj, test_vm):

In this case we require the test to be run twice, once for prov_1 and then again for prov_2. We are going to use the generate function to help us provide parameters to pass to pytest_generate_tests(). pytest_generate_tests() requires three pieces of information, argnames, argvalues and an idlist. argnames turns into the names we use for fixtures. In this case, provider_obj and provider_mgmt_sys. argvalues becomes the place where the provider_obj and provider_mgmt_sys items are stored. Each element of argvalues is a list containing a value for both provider_obj and provider_mgmt_sys. Thus, taking an element from argvalues gives us the values to unpack to make up one test. An example is below, where we assume that a provider object is obtained via the Provider class, and the mgmt_sys object is obtained via a Wrapanapi class.

~ provider_obj test_vm
prov1 Provider(prov1) abc1
prov2 Provider(prov2) abc2

This is analogous to the following layout:

~ argnames[0] argnames[1]
idlist[0] argvalues[0][0] argvalues[0][1]
idlist[1] argvalues[1][0] argvalues[1][1]

This could be generated like so:

def gen_providers:

    argnames = ['provider_obj', 'test_vm']
    argvalues = []
    idlist = []

    for provider in yaml['providers']:
        idlist.append(provider)
        argvalues.append([
            Provider(yaml['providers'][provider]['name']),
            yaml['providers'][provider]['test_vm'])
        ])

    return argnames, argvalues, idlist

This is then used with pytest_generate_tests like so:

pytest_generate_tests(gen_providers)

Additionally, py.test joins the values of idlist with dashes to generate a unique id for this test, falling back to joining argnames with dashes if idlist is not set. This is the value seen in square brackets in a test report on parametrized tests.

More information on parametrize can be found in pytest’s documentation:

utils.testgen.all_providers(metafunc, **options)[source]

Returns providers of all types

utils.testgen.auth_groups(metafunc, auth_mode)[source]

Provides two test params based on the ‘auth_modes’ and ‘group_roles’ in cfme_data:

group_name:
expected group name in provided by the backend specified in auth_mode
group_data:
list of nav destinations that should be visible as a member of group_name
Parameters:auth_mode – One of the auth_modes specified in cfme_data.get('auth_modes', {})
utils.testgen.config_managers(metafunc)[source]

Provides config managers

utils.testgen.generate(*args, **kwargs)[source]

Functional handler for inline pytest_generate_tests definition

Parameters:
  • gen_func – Test generator function, expected to return argnames, argvalues, and an idlist suitable for use with pytest’s parametrize method in pytest_generate_tests hooks
  • indirect – Optional keyword argument. If seen, it will be removed from the kwargs passed to gen_func and used in the wrapped pytest parametrize call
  • scope – Optional keyword argument. If seen, it will be removed from the kwargs passed to gen_func and used in the wrapped pytest parametrize call
  • filter_unused – Optional keyword argument. If True (the default), parametrized tests will be inspected, and only argnames matching fixturenames will be used to parametrize the test. If seen, it will be removed from the kwargs passed to gen_func.
  • *args – Additional positional arguments which will be passed to gen_func
  • **kwargs – Additional keyword arguments whill be passed to gen_func

Usage:

# Abstract example:
pytest_generate_tests = testgen.generate(arg1, arg2, kwarg1='a')

# Concrete example using all infrastructure providers and module scope
pytest_generate_tests = testgen.generate([InfraProvider], scope="module")

# Another concrete example using only VMware and SCVMM providers with 'retire' flag
pf = ProviderFilter(
    classes=[WMwareProvider, SCVMMProvider]), required_flags=['retire'])
pytest_generate_tests = testgen.generate(
    gen_func=testgen.providers, filters=[pf], scope="module")

Note

filter_unused is helpful, in that you don’t have to accept all of the args in argnames in every test in the module. However, if all tests don’t share one common parametrized argname, py.test may not have enough information to properly organize tests beyond the ‘function’ scope. Thus, when parametrizing in the module scope, it’s a good idea to include at least one common argname in every test signature to give pytest a clue in sorting tests.

utils.testgen.parametrize(metafunc, argnames, argvalues, *args, **kwargs)[source]

parametrize wrapper that calls _param_check(), and only parametrizes when needed

This can be used in any place where conditional parametrization is used.

utils.testgen.providers(metafunc, filters=None)[source]

Gets providers based on given (+ global) filters

Note

Using the default ‘function’ scope, each test will be run individually for each provider before moving on to the next test. To group all tests related to single provider together, parametrize tests in the ‘module’ scope.

Note

testgen for providers now requires the usage of test_flags for collection to work. Please visit http://cfme-tests.readthedocs.org/guides/documenting.html#documenting-tests for more details.

utils.testgen.providers_by_class(metafunc, classes, required_fields=None)[source]

Gets providers by their class

Parameters:
  • metafunc – Passed in by pytest
  • classes – List of classes to fetch
  • required_fields – See cfme.utils.provider.ProviderFilter

Usage:

# In the function itself
def pytest_generate_tests(metafunc):
    argnames, argvalues, idlist = testgen.providers_by_class(
        [GCEProvider, AzureProvider], required_fields=['provisioning']
    )
metafunc.parametrize(argnames, argvalues, ids=idlist, scope='module')

# Using the parametrize wrapper
pytest_generate_tests = testgen.parametrize([GCEProvider], scope='module')
utils.testgen.pxe_servers(metafunc)[source]

Provides pxe data based on the server_type

Parameters:server_name – One of the server names to filter by, or ‘all’.
utils.timeutil module

This module should contain all things associated with time or date that can be shared.

utils.timeutil.nice_seconds(t_s)[source]

Return nicer representation of seconds

class utils.timeutil.parsetime[source]

Bases: datetime.datetime

Modified class with loaders for our datetime formats.

american_date_only_format = '%m/%d/%y'
american_minutes = '%m/%d/%y %H:%M'
american_minutes_with_utc = '%m/%d/%y %H:%M UTC'
american_with_utc_format = '%m/%d/%y %H:%M:%S UTC'
classmethod from_american_date_only(time_string)[source]

Convert the string representation of the time into parsetime()

CFME’s format here is ‘mm/dd/yy’

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

classmethod from_american_minutes(time_string)[source]

Convert the string representation of the time into parsetime()

CFME’s format here is ‘mm/dd/yy hh:mm’

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

classmethod from_american_minutes_with_utc(time_string)[source]

Convert the string representation of the time into parsetime()

CFME’s format here is ‘mm/dd/yy hh:mm UTC’

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

classmethod from_american_with_utc(time_string)[source]

Convert the string representation of the time into parsetime()

CFME’s format here is ‘mm/dd/yy hh:mm:ss UTC’

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

classmethod from_iso_date(time_string)[source]

Convert the string representation of the time into parsetime()

Format here is ‘YYYY-MM-DD’

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

classmethod from_iso_with_utc(time_string)[source]

Convert the string representation of the time into parsetime()

CFME’s format here is ‘mm-dd-yy hh:mm:ss UTC’

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

classmethod from_long_date_format(time_string)[source]

Convert the string representation of the time into parsetime()

Format here is ‘%B %d, %Y %H:%M’.

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

classmethod from_request_format(time_string)[source]

Convert the string representation of the time into parsetime()

Format here is ‘YYYY-MM-DD-HH-MM-SS’. Used for transmitting data over http

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

classmethod from_saved_report_title_format(time_string)[source]

Convert the string representation of the time into parsetime()

Format here is ‘%a, %d %b %Y %H:%M:%S +0000’.

Parameters:time_string – String with time to parse

Returns: :py:class`utils.timeutil.datetime()` object

iso_date_only_format = '%Y-%m-%d'
iso_with_utc_format = '%Y-%m-%d %H:%M:%S UTC'
long_date_format = '%B %d, %Y %H:%M'
request_format = '%Y-%m-%d-%H-%M-%S'
saved_report_title_format = '%a, %d %b %Y %H:%M:%S +0000'
to_american_date_only()[source]

Convert the this object to string representation in american date only format.

CFME’s format here is ‘mm/dd/yy’

Returns: :py:class`str` object

to_american_minutes()[source]

Convert the this object to string representation in american with just minutes.

CFME’s format here is ‘mm/dd/yy hh:mm’

Returns: :py:class`str` object

to_american_minutes_with_utc()[source]

Convert the this object to string representation in american with just minutes.

CFME’s format here is ‘mm/dd/yy hh:mm’

Returns: :py:class`str` object

to_american_with_utc()[source]

Convert the this object to string representation in american with UTC.

CFME’s format here is ‘mm/dd/yy hh:mm:ss UTC’

Returns: :py:class`str` object

to_iso_date()[source]

Convert the this object to string representation in ISO format.

Format here is ‘YYYY-MM-DD’

Returns: :py:class`str` object

to_iso_with_utc()[source]

Convert the this object to string representation in american with UTC.

CFME’s format here is ‘mm-dd-yy hh:mm:ss UTC’

Returns: :py:class`str` object

to_long_date_format()[source]

Convert the this object to string representation in http request.

Format here is ‘%B %d, %Y %H:%M’

Returns: :py:class`str` object

to_request_format()[source]

Convert the this object to string representation in http request.

Format here is ‘YYYY-MM-DD-HH-MM-SS’

Returns: :py:class`str` object

to_saved_report_title_format()[source]

Convert the this object to string representation in Saved Report title.

Format here is ‘%a, %d %b %Y %H:%M:%S +0000’

Returns: :py:class`str` object

utils.tracer module

To use the function tracer, simply import the trace object and wrap a function with it

from utils.tracer import trace:

@trace(scope=3)
def func():
    print("something")
class utils.tracer.FileStore[source]

Bases: object

utils.tracer.trace(scope=1)[source]

Very simple tracer for functions and tests

The tracer module is a very simple tracer that prints out lines of code as they are executed. It is useful when debugging tests so that you can actually see the lines of code being executed and hence determine where blocks are happening. This is not a substitute for good logging but a simple enhancement.

Parameters:scope – This determines the depth of nested functions to go down, defaults to 1
utils.trackerbot module
class utils.trackerbot.Group(name, stream=True, active=True)[source]

Bases: dict

dict subclass to help serialize groups as JSON

class utils.trackerbot.Provider(key)[source]

Bases: dict

dict subclass to help serialize providers as JSON

class utils.trackerbot.ProviderTemplate(provider, template, usable=None, tested=None)[source]

Bases: dict

dict subclass to help serialize providertemplate details as JSON

concat_id
class utils.trackerbot.Template(name, group=None, datestamp=None)[source]

Bases: dict

dict subclass to help serialize templates as JSON

class utils.trackerbot.TemplateInfo(group_name, datestamp, stream)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

datestamp

Alias for field number 1

group_name

Alias for field number 0

stream

Alias for field number 2

utils.trackerbot.active_streams(api, force=False)[source]
utils.trackerbot.api(trackerbot_url=None)[source]

Return an API object authenticated to the given trackerbot api

utils.trackerbot.cmdline_parser()[source]

Get a parser with basic trackerbot configuration params already set up

It will use the following keys from the env conf if they’re available:

# with example values
trackerbot:
    url: http://hostname/api/
    username: username
    apikey: 0123456789abcdef
utils.trackerbot.composite_uncollect(build, source='jenkins')[source]

Composite build function

utils.trackerbot.delete_provider_template(api, provider, template)[source]

Delete a provider/template relationship, used when a template is removed from one provider

utils.trackerbot.depaginate(api, result)[source]

Depaginate the first (or only) page of a paginated result

utils.trackerbot.futurecheck(check_date)[source]

Given a date object, return a date object that isn’t from the future

Some templates only have month/day values, not years. We create a date object

utils.trackerbot.latest_template(api, group, provider_key=None)[source]
utils.trackerbot.mark_provider_template(api, provider, template, tested=None, usable=None, diagnosis='', build_number=None, stream=None)[source]

Mark a provider template as tested and/or usable

Parameters:
  • api – The trackerbot API to act on
  • provider – The provider’s key in cfme_data or a Provider instance
  • template – The name of the template to mark on this provider or a Template
  • tested – Whether or not this template has been tested on this provider
  • usable – Whether or not this template is usable on this provider
  • diagnosis – Optional reason for marking a template

Returns the response of the API request

utils.trackerbot.parse_template(template_name)[source]

Given a template name, attempt to extract its group name and upload date

Returns:
  • None if no groups matched
  • group_name, datestamp of the first matching group. group name will be a string, datestamp with be a datetime.date, or None if a date can’t be derived from the template name
utils.trackerbot.post_jenkins_result(job_name, number, stream, date, template, build_status, artifact_report)[source]
utils.trackerbot.post_task_result(tid, result, output=None, coverage=0.0)[source]
utils.trackerbot.provider_templates(api)[source]
utils.trackerbot.set_provider_active(api, provider, active=True)[source]

Set a provider active (or inactive)

Parameters:
  • api – The trackerbot API to act on
  • active – active flag to set on the provider (True or False)
utils.trackerbot.templates_to_test(api, limit=1, request_type=None)[source]

get untested templates to pass to jenkins

Parameters:
  • limit – max number of templates to pull per request
  • request_type – request the provider_key of specific type
  • openstack (e.g) –
utils.trackerbot.trackerbot_add_provider_template(stream, provider, template_name)[source]
utils.units module
class utils.units.Unit(number, prefix, unit_type)[source]

Bases: object

This class serves for simple comparison of numbers that have units.

Imagine you pull a text value from the UI. 2 GB. By doing Unit.parse('2 GB') you get an instance of Unit, which is comparable.

You can compare two Unit instances or you can compare Unit with int, float or any str as long as it can go through the Unit.parse().

If you compare Unit only (or a string that gets subsequently parsed), it also takes the kind of the unit it is, you cannot compare bytes with hertzes. It then calculates the absolute value in the base units and that gets compared.

If you compare with a number, it does it like it was the number of the same unit. So eg. doing:

Unit.parse('2 GB') == 2 *1024 * 1024 * 1024 `` is True
absolute
number
classmethod parse(s)[source]
prefix
unit_type
utils.update module
class utils.update.Updateable[source]

Bases: object

A mixin that helps make an object easily updateable. Two Updateables are equal if all their public fields are equal.

utils.update.all_public_fields_equal(a, b)[source]
utils.update.public_fields(o)[source]

Returns: a dict of fields whose name don’t start with underscore.

utils.update.update(*args, **kwds)[source]

Update an object and then sync it with an external application.

It will copy the object into whatever is named in the ‘as’ clause, run the ‘with’ code block (which presumably alters the object). Then the update() method on the original object will be called with a dict containing only changed fields, and kwargs passed to this function.

If an exception is thrown by update(), the original object will be restored, otherwise the updated object will be returned.

Usage:

with update(myrecord):
   myrecord.lastname = 'Smith'
utils.update.updates(old, new)[source]

Return a dict of fields that are different between old and new.

utils.varmeth module

Method variant decorator. You specify the desired method variant by a kwarg.

from utils.varmeth import variable

class SomeClass(object):
    secret = 42

    @variable
    def mymethod(self):
        print("I am default!")

    @mymethod.variant("foo", "foo_too")
    def i_foo(self):
        print("I foo!")

    @mymethod.variant("bar")
    def in_bar(self):
        print("In bar!")

    @variable(alias="foo")
    def myfoo(self):
        print("foo!")

s = SomeClass()
s.mymethod()  # => I am default!
s.mymethod(method="moo")  # => I am default!
s.mymethod(method="foo")  # => I foo!
s.mymethod(method="foo_too")  # => I foo!
s.mymethod(method="bar")  # => In bar!
s.mymethod(method="baz")  # => AttributeError
s.myfoo()  # => foo!
s.myfoo(method="foo")  # => foo!
Original idea:
Pete Savage
Implementation:
Milan Falešník
class utils.varmeth.variable(*args, **kwargs)[source]

Bases: object

Create a new variable method.

variant(*names)[source]

Register a new variant of a method under a name.

utils.version module
utils.version.SPTuple

alias of StreamProductTuple

class utils.version.Version(vstring)[source]

Bases: object

Version class based on distutil.version.LooseVersion

SUFFIXES = ('nightly', 'pre', 'alpha', 'beta', 'rc')
SUFFIXES_STR = '-nightly(?:\\d+(?:\\.\\d+)?)?|-pre(?:\\d+(?:\\.\\d+)?)?|-alpha(?:\\d+(?:\\.\\d+)?)?|-beta(?:\\d+(?:\\.\\d+)?)?|-rc(?:\\d+(?:\\.\\d+)?)?'
__contains__(ver)[source]

Enables to use in expression for Version.is_in_series().

Example

"5.5.5.2" in Version("5.5") returns ``True

Parameters:ver – Version that should be checked if it is in series of this version. If str provided, it will be converted to Version.
component_re = <_sre.SRE_Pattern object at 0x3cc2f60>
is_in_series(series)[source]

This method checks whether the version belongs to another version’s series.

Eg.: Version("5.5.5.2").is_in_series("5.5") returns True

Parameters:series – Another Version to check against. If string provided, will be converted to Version
classmethod latest()[source]
classmethod lowest()[source]
normalized_suffix

Turns the string suffixes to numbers. Creates a list of tuples.

The list of tuples is consisting of 2-tuples, the first value says the position of the suffix in the list and the second number the numeric value of an eventual numeric suffix.

If the numeric suffix is not present in a field, then the value is 0

parse(vstring)[source]
product_version()[source]
series(n=2)[source]
stream()[source]
suffix_item_re = <_sre.SRE_Pattern object>
utils.version.appliance_build_date()[source]
utils.version.appliance_build_datetime()[source]
utils.version.appliance_has_netapp()[source]
utils.version.appliance_is_downstream()[source]
utils.version.before_date_or_version(date=None, version=None)[source]

Function for deciding based on the build date and version.

Usage:

* If both date and version are set, then two things can happen. If the appliance is
    downstream, both date and version are checked, otherwise only the date.
* If only date is set, then only date is checked.
* if only version is set, then it checks the version if the appliance is downstream,
    otherwise it returns ``False``

The checks are in form appliance_build_date() < date and current_version() < version. Therefore when used in if statement, the truthy value signalizes ‘older’ version and falsy signalizes ‘newer’ version.

utils.version.current_stream()[source]
utils.version.current_version()[source]

A lazy cached method to return the appliance version.

Do not catch errors, since generally we cannot proceed with testing, without knowing the server version.

utils.version.dependent(default_function)[source]
utils.version.get_product_version(ver)[source]

Return product version for given Version obj or version string

utils.version.get_stream(ver)[source]

Return a stream name for given Version obj or version string

utils.version.get_version(obj=None)[source]

Return a Version based on obj. For CFME, ‘master’ version means always the latest (compares as greater than any other version)

If obj is None, the version will be retrieved from the current appliance

utils.version.parsedate(o)[source]
utils.version.pick(v_dict)[source]

Collapses an ambiguous series of objects bound to specific versions by interrogating the CFME Version and returning the correct item.

utils.version.product_version_dispatch(*_args, **_kwargs)[source]

Dispatch function for use in multimethods that just ignores arguments and dispatches on the current product version.

utils.version.since_date_or_version(*args, **kwargs)[source]

Opposite of before_date_or_version()

utils.video module

Video recording library

Configuration for this module + fixture: .. code-block:: yaml

logging:
video:
enabled: True dir: video display: ”:99” quality: 10
class utils.video.Recorder(filename, display=None, quality=None)[source]

Bases: object

Recorder class

Usage:

with Recorder(filename):
    # do something

# or
r = Recorder(filename)
r.start()
# do something
r.stop()

The first way is preferred, obviously

__del__()[source]

If the reference is lost and the object is destroyed ...

start()[source]
stop()[source]
utils.video.process_running(pid)[source]

Check whether specified process is running

utils.virtual_machines module

Helper functions related to the creation and destruction of virtual machines and instances

utils.virtual_machines.deploy_template(provider_key, vm_name, template_name=None, timeout=900, **deploy_args)[source]
Parameters:
  • provider_key – Provider key on which the VM is to be created
  • vm_name – Name of the VM to be deployed
  • template_name – Name of the template that the VM is deployed from
  • timeout – the timeout for template deploy
utils.wait module
utils.workloads module

Functions for workloads.

utils.workloads.get_capacity_and_utilization_replication_scenarios()[source]
utils.workloads.get_capacity_and_utilization_scenarios()[source]
utils.workloads.get_idle_scenarios()[source]
utils.workloads.get_provisioning_scenarios()[source]
utils.workloads.get_refresh_providers_scenarios()[source]
utils.workloads.get_refresh_vms_scenarios()[source]
utils.workloads.get_smartstate_analysis_scenarios()[source]
utils.workloads.get_ui_single_page_scenarios()[source]

Module contents

class utils.FakeObject(**kwargs)[source]

Bases: object

class utils.InstanceClassMethod(instance_or_class_method)[source]

Bases: object

Decorator-descriptor that enables you to use any method both as class and instance one

Usage:

class SomeClass(object):
    @InstanceClassMethod
    def a_method(self):
        the_instance_variant()

    @a_method.classmethod
    def a_method(cls):
        the_class_variant()

i = SomeClass()
i.a_method()
SomeClass.a_method()
# Both are possible

If you don’t pass classmethod the “instance” method, the one that was passed first will be called for both kinds of invocation.

classmethod(class_method)[source]
class utils.ParamClassName(instance_attr, class_attr='__name__')[source]

Bases: object

ParamClassName is a Descriptor to help when using classes and instances as parameters

Note: This descriptor is a hack until collections are implemented everywhere

Usage:

class Provider(object):
    _param_name = ParamClassName('name')

    def __init__(self, name):
        self.name = name

When accessing the _param_name on the class object it will return the __name__ of the class by default. When accessing the _param_name on an instance of the class, it will return the attribute that is passed in.

utils.at_exit(f, *args, **kwargs)[source]

Diaper-protected atexit handler registering. Same syntax as atexit.register()

utils.attributize_string(text)[source]

Converts a string to a lowercase string containing only letters, digits and underscores.

Usable for eg. generating object key names. The underscore is always one character long if it is present.

utils.castmap(t, i, *args, **kwargs)[source]

Works like the map() but is made specially to map classes on iterables.

This function only applies the t to the item of i if it is not of that type.

Parameters:
  • t – The class that you want all theitems in the list to be type of.
  • i – Iterable with items to be cast.
Returns:

A list.
utils.classproperty(f)[source]

Enables properties for whole classes:

Usage:

>>> class Foo(object):
...     @classproperty
...     def bar(cls):
...         return "bar"
...
>>> print(Foo.bar)
baz
utils.clear_property_cache(obj, *names)[source]

clear a cached property regardess of if it was cached priority

class utils.deferred_verpick(version_pick)[source]

Bases: object

descriptor that version-picks on Access

Useful for verpicked constants in classes

utils.fakeobject_or_object(obj, attr, default=None)[source]
utils.icastmap(t, i, *args, **kwargs)[source]

Works like the map() but is made specially to map classes on iterables. A generator version.

This function only applies the t to the item of i if it is not of that type.

Parameters:
  • t – The class that you want all the yielded items to be type of.
  • i – Iterable with items to be cast.
Returns:

A generator.
utils.iterate_pairs(iterable)[source]

Iterates over iterable, always taking two items at time.

Eg. [1, 2, 3, 4, 5, 6] will yield (1, 2), then (3, 4) ...

Must have even number of items.

Parameters:iterable – An iterable with even number of items to be iterated over.
utils.normalize_space(text)[source]

Works in accordance with the XPath’s normalize-space() operator.

Description:

The normalize-space function strips leading and trailing white-space from a string, replaces sequences of whitespace characters by a single space, and returns the resulting string.
utils.normalize_text(text)[source]

Converts a string to a lowercase string containing only letters, digits and spaces.

The space is always one character long if it is present.

utils.process_pytest_path(path)[source]
utils.process_shell_output(value)[source]

This function allows you to unify the behaviour when you putput some values to stdout.

You can check the code of the function how exactly does it behave for the particular types of variables. If no output is expected, it returns None.

Parameters:value – Value to be outputted.
Returns:A tuple consisting of returncode and the output to be printed.
utils.read_env(file)[source]

Given a py.path.Local file name, return a dict of exported shell vars and their values.

Parameters:file – A py.path.Local instance.

Note

This will only include shell variables that are exported from the file being parsed

Returns:A dict of key/value pairs. If the file does not exist or bash could not parse the file, this dict will be empty.
utils.safe_string(o)[source]

This will make string out of ANYTHING without having to worry about the stupid Unicode errors

This function tries to make str/unicode out of o unless it already is one of those and then it processes it so in the end there is a harmless ascii string.

Parameters:o – Anything.
utils.tries(num_tries, exceptions, f, *args, **kwargs)[source]

Tries to call the function multiple times if specific exceptions occur.

Parameters:
  • num_tries – How many times to try if exception is raised
  • exceptions – Tuple (or just single one) of exceptions that should be treated as repeat.
  • f – Callable to be called.
  • *args – Arguments to be passed through to the callable
  • **kwargs – Keyword arguments to be passed through to the callable
Returns:

What f returns.
Raises:

What f raises if the try count is exceeded.

Indices and tables