From 703b9e88a3b06845b9499943dcf0994494f099dd Mon Sep 17 00:00:00 2001 From: Jasper Berton Date: Wed, 19 Feb 2025 15:45:16 +0100 Subject: [PATCH] ci: updated build to work with most recent pdoc version Documentation updated so that it builds properly with most recent pdoc version. Alterations made: - Links now work - codeblocks updated - full documentation now renders Signed-off-by: Jasper Berton --- .github/workflows/build.yaml | 33 +- lib/ovirtsdk4/__init__.py | 117 +- lib/ovirtsdk4/readers.py | 436 ++ lib/ovirtsdk4/service.py | 9 +- lib/ovirtsdk4/services.py | 12635 ++++++++++++++++++++------------- lib/ovirtsdk4/types.py | 506 ++ lib/ovirtsdk4/writer.py | 18 +- lib/ovirtsdk4/writers.py | 438 ++ pdoc/custom.css | 3 + 9 files changed, 9049 insertions(+), 5146 deletions(-) create mode 100644 pdoc/custom.css diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index cdf2a5d..d3d1e1e 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -21,6 +21,7 @@ jobs: - name: centos-stream-9 shortcut: c9s container-name: el9stream + pip-command: pip3 name: ${{ matrix.name }} @@ -86,15 +87,15 @@ jobs: ref: 'gh-pages' generate_documentation: - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - name: Install Dependencies # This step installs dependencies for python-sdk and pdoc run: | sudo apt update && sudo apt install -y git \ - python2 \ - python2-dev \ + python3 \ + python3-dev \ curl \ asciidoctor \ gcc \ @@ -109,34 +110,26 @@ jobs: - name: Checkout sources uses: actions/checkout@v4 - - name: Install pip2.7 - # This step installs pip2.7, which will be needed later - run: | - curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py - python2 get-pip.py - - - name: Install Python-SDK with Python 2.7 + - name: Install Python-SDK with Python 3 # This step installs the python-sdk with python2.7, as the extension of pdoc, # which is subsequently installed, doesn't have python3 support. run: | - pip2.7 install setuptools + pip install setuptools bash .automation/generate-setup-files.sh - python2.7 setup.py install --user --prefix= + python3 setup.py install --user --prefix= shell: bash - name: Install Pdoc # This steps installs an extension of pdoc which supports asciidoc # (this extension runs on python2). run: | - git clone https://github.com/machacekondra/pdoc - cd pdoc - pip2.7 install -U . + pip install pdoc - name: Install pygments - run: pip2.7 install pygments + run: pip install pygments - name: Generate documentation - run: pdoc ovirtsdk4 --html --html-dir=html + run: pdoc ovirtsdk4 -o ./${{ env.GEN_DOC_DIR }} -t pdoc - name: Upload generated documentation artifacts uses: actions/upload-artifact@v4 @@ -157,7 +150,7 @@ jobs: uses: actions/download-artifact@v4 with: name: generated-documentation - path: ${{ env.GEN_DOC_DIR }} + path: ${{ env.GEN_DOC_DIR }}/ - name: Install package dependencies run: | @@ -197,8 +190,8 @@ jobs: - name: Move created documentation to gh-pages run: | - mkdir -p ./ovirt-engine-sdk/${{env.FOLDER}}/ - cp ./html/ovirtsdk4/* ./ovirt-engine-sdk/${{env.FOLDER}}/ + mkdir -p ./ovirt-engine-sdk/${{ env.FOLDER }}/ + cp -r ./${{ env.GEN_DOC_DIR }}/* ./ovirt-engine-sdk/${{ env.FOLDER }}/ - name: Push changes to gh-pages run: | diff --git a/lib/ovirtsdk4/__init__.py b/lib/ovirtsdk4/__init__.py index ebc388c..2cca6d8 100644 --- a/lib/ovirtsdk4/__init__.py +++ b/lib/ovirtsdk4/__init__.py @@ -31,9 +31,11 @@ from urllib import urlencode from urlparse import urlparse -from ovirtsdk4 import version from ovirtsdk4.http import Response +def get_version(): + from ovirtsdk4 import version + return version.VERSION class Error(Exception): """ @@ -44,20 +46,22 @@ class Error(Exception): def __init__(self, message, code=None, fault=None): """ Creates an instance of Error class. - - `message`:: The exception message. - - `code`:: An error code associated to the error. For HTTP related - errors, this will be the HTTP response code returned by the server. - For example, if retrieving of a virtual machine fails because it - doesn't exist this attribute will contain the integer value 404. Note - that this may be `nil` if the error is not HTTP related. - - `fault`:: The `Fault` object associated to the error. """ super(Error, self).__init__(message) + """ + Creates an instance of Error class. + """ self.code = code + """ + An error code associated to the error. For HTTP related + errors, this will be the HTTP response code returned by the server. + For example, if retrieving of a virtual machine fails because it + doesn't exist this attribute will contain the integer value 404. Note + that this may be `nil` if the error is not HTTP related.""" self.fault = fault + """ + The `Fault` object associated to the error. + """ class AuthError(Error): @@ -230,70 +234,87 @@ def __init__( This method supports the following parameters: - `url`:: A string containing the base URL of the server, usually + `url` \n + A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. - `username`:: The name of the user, something like `admin@internal`. + `username` \n + The name of the user, something like `admin@internal`. - `password`:: The name password of the user. + `password` \n + The name password of the user. - `token`:: : The token to be used to access API. Optionally, user can + `token` \n + The token to be used to access API. Optionally, user can use token, instead of username and password to access API. If user don't specify `token` parameter, SDK will automatically create one. - `insecure`:: A boolean flag that indicates if the server TLS + `insecure` \n + A boolean flag that indicates if the server TLS certificate and host name should be checked. - `ca_file`:: A PEM file containing the trusted CA certificates. The + `ca_file` \n + A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If `ca_file` parameter is not set, system wide CA certificate store is used. - `debug`:: A boolean flag indicating if debug output should be + `debug` \n + A boolean flag indicating if debug output should be generated. If the value is `True` and the `log` parameter isn't `None` then the data sent to and received from the server will be written to the log. Be aware that user names and passwords will also be written, so handle it with care. - `log`:: The logger where the log messages will be written. + `log` \n + The logger where the log messages will be written. - `kerberos`:: A boolean flag indicating if Kerberos + `kerberos` \n + A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. - `timeout`:: The maximum total time to wait for the response, in + `timeout` \n + The maximum total time to wait for the response, in seconds. A value of zero (the default) means wait for ever. If the timeout expires before the response is received an exception will be raised. - `compress`:: A boolean flag indicating if the SDK should ask + `compress` \n + A boolean flag indicating if the SDK should ask the server to send compressed responses. The default is `True`. Note that this is a hint for the server, and that it may return uncompressed data even when this parameter is set to `True`. Note that compression will be disabled if user pass `debug` parameter set to `true`, so the debug messages are in plain text. - `sso_url`:: A string containing the base SSO URL of the serve. + `sso_url` \n + A string containing the base SSO URL of the serve. Default SSO url is computed from the `url` if no `sso_url` is provided. - `sso_revoke_url`:: A string containing the base URL of the SSO + `sso_revoke_url` \n + A string containing the base URL of the SSO revoke service. This needs to be specified only when using an external authentication service. By default this URL is automatically calculated from the value of the `url` parameter, so that SSO token revoke will be performed using the SSO service that is part of the engine. - `sso_token_name`:: The token name in the JSON SSO response returned + `sso_token_name` \n + The token name in the JSON SSO response returned from the SSO server. Default value is `access_token`. - `headers`:: A dictionary with headers which should be send with every + `headers` \n + A dictionary with headers which should be send with every request. - `connections`:: The maximum number of connections to open to the host. + `connections` \n + The maximum number of connections to open to the host. If the value is `0` (the default) then the number of connections will be unlimited. - `pipeline`:: The maximum number of request to put in an HTTP pipeline + `pipeline` \n + The maximum number of request to put in an HTTP pipeline without waiting for the response. If the value is `0` (the default) then pipelining is disabled. """ @@ -360,7 +381,8 @@ def send(self, request): This method supports the following parameters. - `request`:: The Request object containing the details of the HTTP + `request` \n + The Request object containing the details of the HTTP request to send. The returned value is a Request object containing the details of the @@ -445,7 +467,7 @@ def __send(self, request): for header_name, header_value in headers_dict.items(): header_lines.append('%s: %s' % (header_name, header_value)) - header_lines.append('User-Agent: PythonSDK/%s' % version.VERSION) + header_lines.append('User-Agent: PythonSDK/%s' % get_version()) header_lines.append('Version: 4') header_lines.append('Content-Type: application/xml') header_lines.append('Accept: application/xml') @@ -796,7 +818,7 @@ def close(self, logout=True): """ Releases the resources used by this connection. - `logout`:: A boolean, which specify if token should be revoked, + `logout` A boolean, which specify if token should be revoked, and so user should be logged out. """ @@ -818,10 +840,10 @@ def _build_url(self, path='', query=None): This method supports the following parameters: - `path`:: The path that will be added to the base URL. The default is an + `path` The path that will be added to the base URL. The default is an empty string. - `query`:: A dictionary containing the query parameters to add to the + `query` A dictionary containing the query parameters to add to the URL. The keys of the dictionary should be strings containing the names of the parameters, and the values should be strings containing the values. @@ -841,7 +863,7 @@ def check_xml_content_type(self, response): XML then it does nothing. If it isn't XML then it raises an exception. - `response`:: The HTTP response to check. + `response` The HTTP response to check. """ return self._check_content_type( self.__XML_CONTENT_TYPE_RE, @@ -855,7 +877,7 @@ def check_json_content_type(self, response): JSON then it does nothing. If it isn't JSON then it raises an exception. - `response`:: The HTTP response to check. + `response` The HTTP response to check. """ return self._check_content_type( self.__JSON_CONTENT_TYPE_RE, @@ -868,10 +890,10 @@ def _check_content_type(self, expected_re, expected_name, headers): Checks the given content type and raises an exception if it isn't the expected one. - `expected_re`:: The regular expression used to check the expected + `expected_re` The regular expression used to check the expected content type. - `expected_name`:: The name of the expected content type. - `headers`:: The HTTP headers to check. + `expected_name` The name of the expected content type. + `headers` The HTTP headers to check. """ content_type = self._get_header_value(headers, 'content-type') if expected_re.match(content_type) is None: @@ -892,7 +914,7 @@ def _read_reponse(self, context): """ Read the response. - `context`:: tuple which contains cur easy, response body, + `context` tuple which contains cur easy, response body, response headers, original request """ # Extract the response code and body: @@ -935,8 +957,8 @@ def _get_header_value(self, headers, name): """ Return header value by its name. - `headers`:: list of headers - `name`:: name of the header + `headers` list of headers + `name` name of the header """ return next( (h.split(':')[1].strip() for h in headers if h.lower().startswith(name)), @@ -984,8 +1006,7 @@ class ConnectionBuilder(object): equivalent to calling the constructor of the `Connection` class. Typical use will be like this: - [source,python] - ---- + ```python # Create the builder once: builder = ConnectionBuilder( url='https://enginer40.example.com/ovirt-engine/api', @@ -1001,7 +1022,7 @@ class ConnectionBuilder(object): # Create and use a second connection: with builder.build() as connection: ... - ---- + ``` """ def __init__(self, **kwargs): @@ -1029,7 +1050,7 @@ def build(self): # import ovirtsdk4 as sdk # vm = sdk.types.Vm() # -from ovirtsdk4 import readers # noqa: F401 -from ovirtsdk4 import services # noqa: F401 -from ovirtsdk4 import types # noqa: F401 -from ovirtsdk4 import writers # noqa: F401 +import ovirtsdk4.readers as readers # noqa: F401 +import ovirtsdk4.writers as writers # noqa: F401 +import ovirtsdk4.types as types # noqa: F401 +import ovirtsdk4.services as services # noqa: F401 diff --git a/lib/ovirtsdk4/readers.py b/lib/ovirtsdk4/readers.py index 81f43e6..f420e06 100644 --- a/lib/ovirtsdk4/readers.py +++ b/lib/ovirtsdk4/readers.py @@ -23,6 +23,8 @@ class ActionReader(Reader): + """ + """ def __init__(self): super(ActionReader, self).__init__() @@ -281,6 +283,8 @@ def read_many(reader): class AffinityGroupReader(Reader): + """ + """ def __init__(self): super(AffinityGroupReader, self).__init__() @@ -405,6 +409,8 @@ def _process_link(link, obj): class AffinityLabelReader(Reader): + """ + """ def __init__(self): super(AffinityLabelReader, self).__init__() @@ -574,6 +580,8 @@ def read_many(reader): class AgentReader(Reader): + """ + """ def __init__(self): super(AgentReader, self).__init__() @@ -666,6 +674,8 @@ def read_many(reader): class AgentConfigurationReader(Reader): + """ + """ def __init__(self): super(AgentConfigurationReader, self).__init__() @@ -741,6 +751,8 @@ def read_many(reader): class ApiReader(Reader): + """ + """ def __init__(self): super(ApiReader, self).__init__() @@ -816,6 +828,8 @@ def read_many(reader): class ApiSummaryReader(Reader): + """ + """ def __init__(self): super(ApiSummaryReader, self).__init__() @@ -887,6 +901,8 @@ def read_many(reader): class ApiSummaryItemReader(Reader): + """ + """ def __init__(self): super(ApiSummaryItemReader, self).__init__() @@ -954,6 +970,8 @@ def read_many(reader): class ApplicationReader(Reader): + """ + """ def __init__(self): super(ApplicationReader, self).__init__() @@ -1028,6 +1046,8 @@ def read_many(reader): class AuthorizedKeyReader(Reader): + """ + """ def __init__(self): super(AuthorizedKeyReader, self).__init__() @@ -1104,6 +1124,8 @@ def read_many(reader): class BackupReader(Reader): + """ + """ def __init__(self): super(BackupReader, self).__init__() @@ -1209,6 +1231,8 @@ def _process_link(link, obj): class BalanceReader(Reader): + """ + """ def __init__(self): super(BalanceReader, self).__init__() @@ -1285,6 +1309,8 @@ def read_many(reader): class BiosReader(Reader): + """ + """ def __init__(self): super(BiosReader, self).__init__() @@ -1352,6 +1378,8 @@ def read_many(reader): class BlockStatisticReader(Reader): + """ + """ def __init__(self): super(BlockStatisticReader, self).__init__() @@ -1417,6 +1445,8 @@ def read_many(reader): class BondingReader(Reader): + """ + """ def __init__(self): super(BondingReader, self).__init__() @@ -1488,6 +1518,8 @@ def read_many(reader): class BookmarkReader(Reader): + """ + """ def __init__(self): super(BookmarkReader, self).__init__() @@ -1562,6 +1594,8 @@ def read_many(reader): class BootReader(Reader): + """ + """ def __init__(self): super(BootReader, self).__init__() @@ -1627,6 +1661,8 @@ def read_many(reader): class BootMenuReader(Reader): + """ + """ def __init__(self): super(BootMenuReader, self).__init__() @@ -1692,6 +1728,8 @@ def read_many(reader): class BrickProfileDetailReader(Reader): + """ + """ def __init__(self): super(BrickProfileDetailReader, self).__init__() @@ -1759,6 +1797,8 @@ def read_many(reader): class CdromReader(Reader): + """ + """ def __init__(self): super(CdromReader, self).__init__() @@ -1856,6 +1896,8 @@ def _process_link(link, obj): class CertificateReader(Reader): + """ + """ def __init__(self): super(CertificateReader, self).__init__() @@ -1934,6 +1976,8 @@ def read_many(reader): class CheckpointReader(Reader): + """ + """ def __init__(self): super(CheckpointReader, self).__init__() @@ -2031,6 +2075,8 @@ def _process_link(link, obj): class CloudInitReader(Reader): + """ + """ def __init__(self): super(CloudInitReader, self).__init__() @@ -2108,6 +2154,8 @@ def read_many(reader): class ClusterReader(Reader): + """ + """ def __init__(self): super(ClusterReader, self).__init__() @@ -2325,6 +2373,8 @@ def _process_link(link, obj): class ClusterFeatureReader(Reader): + """ + """ def __init__(self): super(ClusterFeatureReader, self).__init__() @@ -2399,6 +2449,8 @@ def read_many(reader): class ClusterLevelReader(Reader): + """ + """ def __init__(self): super(ClusterLevelReader, self).__init__() @@ -2492,6 +2544,8 @@ def _process_link(link, obj): class ConfigurationReader(Reader): + """ + """ def __init__(self): super(ConfigurationReader, self).__init__() @@ -2559,6 +2613,8 @@ def read_many(reader): class ConsoleReader(Reader): + """ + """ def __init__(self): super(ConsoleReader, self).__init__() @@ -2624,6 +2680,8 @@ def read_many(reader): class CoreReader(Reader): + """ + """ def __init__(self): super(CoreReader, self).__init__() @@ -2691,6 +2749,8 @@ def read_many(reader): class CpuReader(Reader): + """ + """ def __init__(self): super(CpuReader, self).__init__() @@ -2772,6 +2832,8 @@ def read_many(reader): class CpuProfileReader(Reader): + """ + """ def __init__(self): super(CpuProfileReader, self).__init__() @@ -2865,6 +2927,8 @@ def _process_link(link, obj): class CpuTopologyReader(Reader): + """ + """ def __init__(self): super(CpuTopologyReader, self).__init__() @@ -2934,6 +2998,8 @@ def read_many(reader): class CpuTuneReader(Reader): + """ + """ def __init__(self): super(CpuTuneReader, self).__init__() @@ -2999,6 +3065,8 @@ def read_many(reader): class CpuTypeReader(Reader): + """ + """ def __init__(self): super(CpuTypeReader, self).__init__() @@ -3068,6 +3136,8 @@ def read_many(reader): class CustomPropertyReader(Reader): + """ + """ def __init__(self): super(CustomPropertyReader, self).__init__() @@ -3137,6 +3207,8 @@ def read_many(reader): class DataCenterReader(Reader): + """ + """ def __init__(self): super(DataCenterReader, self).__init__() @@ -3282,6 +3354,8 @@ def _process_link(link, obj): class DeviceReader(Reader): + """ + """ def __init__(self): super(DeviceReader, self).__init__() @@ -3377,6 +3451,8 @@ def _process_link(link, obj): class DiskReader(Reader): + """ + """ def __init__(self): super(DiskReader, self).__init__() @@ -3562,6 +3638,8 @@ def _process_link(link, obj): class DiskAttachmentReader(Reader): + """ + """ def __init__(self): super(DiskAttachmentReader, self).__init__() @@ -3654,6 +3732,8 @@ def read_many(reader): class DiskProfileReader(Reader): + """ + """ def __init__(self): super(DiskProfileReader, self).__init__() @@ -3747,6 +3827,8 @@ def _process_link(link, obj): class DiskSnapshotReader(Reader): + """ + """ def __init__(self): super(DiskSnapshotReader, self).__init__() @@ -3936,6 +4018,8 @@ def _process_link(link, obj): class DisplayReader(Reader): + """ + """ def __init__(self): super(DisplayReader, self).__init__() @@ -4029,6 +4113,8 @@ def read_many(reader): class DnsReader(Reader): + """ + """ def __init__(self): super(DnsReader, self).__init__() @@ -4096,6 +4182,8 @@ def read_many(reader): class DnsResolverConfigurationReader(Reader): + """ + """ def __init__(self): super(DnsResolverConfigurationReader, self).__init__() @@ -4161,6 +4249,8 @@ def read_many(reader): class DomainReader(Reader): + """ + """ def __init__(self): super(DomainReader, self).__init__() @@ -4259,6 +4349,8 @@ def _process_link(link, obj): class DynamicCpuReader(Reader): + """ + """ def __init__(self): super(DynamicCpuReader, self).__init__() @@ -4326,6 +4418,8 @@ def read_many(reader): class EntityProfileDetailReader(Reader): + """ + """ def __init__(self): super(EntityProfileDetailReader, self).__init__() @@ -4391,6 +4485,8 @@ def read_many(reader): class ErrorHandlingReader(Reader): + """ + """ def __init__(self): super(ErrorHandlingReader, self).__init__() @@ -4456,6 +4552,8 @@ def read_many(reader): class EventReader(Reader): + """ + """ def __init__(self): super(EventReader, self).__init__() @@ -4562,6 +4660,8 @@ def read_many(reader): class EventSubscriptionReader(Reader): + """ + """ def __init__(self): super(EventSubscriptionReader, self).__init__() @@ -4642,6 +4742,8 @@ def read_many(reader): class ExternalComputeResourceReader(Reader): + """ + """ def __init__(self): super(ExternalComputeResourceReader, self).__init__() @@ -4722,6 +4824,8 @@ def read_many(reader): class ExternalDiscoveredHostReader(Reader): + """ + """ def __init__(self): super(ExternalDiscoveredHostReader, self).__init__() @@ -4804,6 +4908,8 @@ def read_many(reader): class ExternalHostReader(Reader): + """ + """ def __init__(self): super(ExternalHostReader, self).__init__() @@ -4880,6 +4986,8 @@ def read_many(reader): class ExternalHostGroupReader(Reader): + """ + """ def __init__(self): super(ExternalHostGroupReader, self).__init__() @@ -4962,6 +5070,8 @@ def read_many(reader): class ExternalHostProviderReader(Reader): + """ + """ def __init__(self): super(ExternalHostProviderReader, self).__init__() @@ -5091,6 +5201,8 @@ def _process_link(link, obj): class ExternalNetworkProviderConfigurationReader(Reader): + """ + """ def __init__(self): super(ExternalNetworkProviderConfigurationReader, self).__init__() @@ -5167,6 +5279,8 @@ def read_many(reader): class ExternalProviderReader(Reader): + """ + """ def __init__(self): super(ExternalProviderReader, self).__init__() @@ -5251,6 +5365,8 @@ def read_many(reader): class ExternalTemplateImportReader(Reader): + """ + """ def __init__(self): super(ExternalTemplateImportReader, self).__init__() @@ -5330,6 +5446,8 @@ def read_many(reader): class ExternalVmImportReader(Reader): + """ + """ def __init__(self): super(ExternalVmImportReader, self).__init__() @@ -5419,6 +5537,8 @@ def read_many(reader): class FaultReader(Reader): + """ + """ def __init__(self): super(FaultReader, self).__init__() @@ -5486,6 +5606,8 @@ def read_many(reader): class FencingPolicyReader(Reader): + """ + """ def __init__(self): super(FencingPolicyReader, self).__init__() @@ -5559,6 +5681,8 @@ def read_many(reader): class FileReader(Reader): + """ + """ def __init__(self): super(FileReader, self).__init__() @@ -5637,6 +5761,8 @@ def read_many(reader): class FilterReader(Reader): + """ + """ def __init__(self): super(FilterReader, self).__init__() @@ -5713,6 +5839,8 @@ def read_many(reader): class FloppyReader(Reader): + """ + """ def __init__(self): super(FloppyReader, self).__init__() @@ -5810,6 +5938,8 @@ def _process_link(link, obj): class FopStatisticReader(Reader): + """ + """ def __init__(self): super(FopStatisticReader, self).__init__() @@ -5877,6 +6007,8 @@ def read_many(reader): class GlusterBrickReader(Reader): + """ + """ def __init__(self): super(GlusterBrickReader, self).__init__() @@ -6001,6 +6133,8 @@ def _process_link(link, obj): class GlusterBrickAdvancedDetailsReader(Reader): + """ + """ def __init__(self): super(GlusterBrickAdvancedDetailsReader, self).__init__() @@ -6110,6 +6244,8 @@ def _process_link(link, obj): class GlusterBrickMemoryInfoReader(Reader): + """ + """ def __init__(self): super(GlusterBrickMemoryInfoReader, self).__init__() @@ -6175,6 +6311,8 @@ def read_many(reader): class GlusterClientReader(Reader): + """ + """ def __init__(self): super(GlusterClientReader, self).__init__() @@ -6246,6 +6384,8 @@ def read_many(reader): class GlusterHookReader(Reader): + """ + """ def __init__(self): super(GlusterHookReader, self).__init__() @@ -6353,6 +6493,8 @@ def _process_link(link, obj): class GlusterMemoryPoolReader(Reader): + """ + """ def __init__(self): super(GlusterMemoryPoolReader, self).__init__() @@ -6441,6 +6583,8 @@ def read_many(reader): class GlusterServerHookReader(Reader): + """ + """ def __init__(self): super(GlusterServerHookReader, self).__init__() @@ -6521,6 +6665,8 @@ def read_many(reader): class GlusterVolumeReader(Reader): + """ + """ def __init__(self): super(GlusterVolumeReader, self).__init__() @@ -6635,6 +6781,8 @@ def _process_link(link, obj): class GlusterVolumeProfileDetailsReader(Reader): + """ + """ def __init__(self): super(GlusterVolumeProfileDetailsReader, self).__init__() @@ -6711,6 +6859,8 @@ def read_many(reader): class GracePeriodReader(Reader): + """ + """ def __init__(self): super(GracePeriodReader, self).__init__() @@ -6776,6 +6926,8 @@ def read_many(reader): class GraphicsConsoleReader(Reader): + """ + """ def __init__(self): super(GraphicsConsoleReader, self).__init__() @@ -6862,6 +7014,8 @@ def read_many(reader): class GroupReader(Reader): + """ + """ def __init__(self): super(GroupReader, self).__init__() @@ -6971,6 +7125,8 @@ def _process_link(link, obj): class GuestOperatingSystemReader(Reader): + """ + """ def __init__(self): super(GuestOperatingSystemReader, self).__init__() @@ -7046,6 +7202,8 @@ def read_many(reader): class HardwareInformationReader(Reader): + """ + """ def __init__(self): super(HardwareInformationReader, self).__init__() @@ -7123,6 +7281,8 @@ def read_many(reader): class HighAvailabilityReader(Reader): + """ + """ def __init__(self): super(HighAvailabilityReader, self).__init__() @@ -7190,6 +7350,8 @@ def read_many(reader): class HookReader(Reader): + """ + """ def __init__(self): super(HookReader, self).__init__() @@ -7268,6 +7430,8 @@ def read_many(reader): class HostReader(Reader): + """ + """ def __init__(self): super(HostReader, self).__init__() @@ -7538,6 +7702,8 @@ def _process_link(link, obj): class HostCpuUnitReader(Reader): + """ + """ def __init__(self): super(HostCpuUnitReader, self).__init__() @@ -7635,6 +7801,8 @@ def _process_link(link, obj): class HostDeviceReader(Reader): + """ + """ def __init__(self): super(HostDeviceReader, self).__init__() @@ -7731,6 +7899,8 @@ def read_many(reader): class HostDevicePassthroughReader(Reader): + """ + """ def __init__(self): super(HostDevicePassthroughReader, self).__init__() @@ -7796,6 +7966,8 @@ def read_many(reader): class HostNicReader(Reader): + """ + """ def __init__(self): super(HostNicReader, self).__init__() @@ -7936,6 +8108,8 @@ def _process_link(link, obj): class HostNicVirtualFunctionsConfigurationReader(Reader): + """ + """ def __init__(self): super(HostNicVirtualFunctionsConfigurationReader, self).__init__() @@ -8005,6 +8179,8 @@ def read_many(reader): class HostStorageReader(Reader): + """ + """ def __init__(self): super(HostStorageReader, self).__init__() @@ -8115,6 +8291,8 @@ def read_many(reader): class HostedEngineReader(Reader): + """ + """ def __init__(self): super(HostedEngineReader, self).__init__() @@ -8188,6 +8366,8 @@ def read_many(reader): class IconReader(Reader): + """ + """ def __init__(self): super(IconReader, self).__init__() @@ -8264,6 +8444,8 @@ def read_many(reader): class IdentifiedReader(Reader): + """ + """ def __init__(self): super(IdentifiedReader, self).__init__() @@ -8336,6 +8518,8 @@ def read_many(reader): class ImageReader(Reader): + """ + """ def __init__(self): super(ImageReader, self).__init__() @@ -8414,6 +8598,8 @@ def read_many(reader): class ImageTransferReader(Reader): + """ + """ def __init__(self): super(ImageTransferReader, self).__init__() @@ -8516,6 +8702,8 @@ def read_many(reader): class InitializationReader(Reader): + """ + """ def __init__(self): super(InitializationReader, self).__init__() @@ -8623,6 +8811,8 @@ def read_many(reader): class InstanceTypeReader(Reader): + """ + """ def __init__(self): super(InstanceTypeReader, self).__init__() @@ -8861,6 +9051,8 @@ def _process_link(link, obj): class IoReader(Reader): + """ + """ def __init__(self): super(IoReader, self).__init__() @@ -8926,6 +9118,8 @@ def read_many(reader): class IpReader(Reader): + """ + """ def __init__(self): super(IpReader, self).__init__() @@ -8997,6 +9191,8 @@ def read_many(reader): class IpAddressAssignmentReader(Reader): + """ + """ def __init__(self): super(IpAddressAssignmentReader, self).__init__() @@ -9064,6 +9260,8 @@ def read_many(reader): class IscsiBondReader(Reader): + """ + """ def __init__(self): super(IscsiBondReader, self).__init__() @@ -9162,6 +9360,8 @@ def _process_link(link, obj): class IscsiDetailsReader(Reader): + """ + """ def __init__(self): super(IscsiDetailsReader, self).__init__() @@ -9259,6 +9459,8 @@ def read_many(reader): class JobReader(Reader): + """ + """ def __init__(self): super(JobReader, self).__init__() @@ -9362,6 +9564,8 @@ def _process_link(link, obj): class KatelloErratumReader(Reader): + """ + """ def __init__(self): super(KatelloErratumReader, self).__init__() @@ -9452,6 +9656,8 @@ def read_many(reader): class KernelReader(Reader): + """ + """ def __init__(self): super(KernelReader, self).__init__() @@ -9517,6 +9723,8 @@ def read_many(reader): class KsmReader(Reader): + """ + """ def __init__(self): super(KsmReader, self).__init__() @@ -9584,6 +9792,8 @@ def read_many(reader): class LinkLayerDiscoveryProtocolElementReader(Reader): + """ + """ def __init__(self): super(LinkLayerDiscoveryProtocolElementReader, self).__init__() @@ -9664,6 +9874,8 @@ def read_many(reader): class LogicalUnitReader(Reader): + """ + """ def __init__(self): super(LogicalUnitReader, self).__init__() @@ -9766,6 +9978,8 @@ def read_many(reader): class MDevTypeReader(Reader): + """ + """ def __init__(self): super(MDevTypeReader, self).__init__() @@ -9837,6 +10051,8 @@ def read_many(reader): class MacReader(Reader): + """ + """ def __init__(self): super(MacReader, self).__init__() @@ -9902,6 +10118,8 @@ def read_many(reader): class MacPoolReader(Reader): + """ + """ def __init__(self): super(MacPoolReader, self).__init__() @@ -9997,6 +10215,8 @@ def _process_link(link, obj): class MemoryOverCommitReader(Reader): + """ + """ def __init__(self): super(MemoryOverCommitReader, self).__init__() @@ -10062,6 +10282,8 @@ def read_many(reader): class MemoryPolicyReader(Reader): + """ + """ def __init__(self): super(MemoryPolicyReader, self).__init__() @@ -10135,6 +10357,8 @@ def read_many(reader): class MethodReader(Reader): + """ + """ def __init__(self): super(MethodReader, self).__init__() @@ -10195,6 +10419,8 @@ def read_many(reader): class MigrationBandwidthReader(Reader): + """ + """ def __init__(self): super(MigrationBandwidthReader, self).__init__() @@ -10262,6 +10488,8 @@ def read_many(reader): class MigrationOptionsReader(Reader): + """ + """ def __init__(self): super(MigrationOptionsReader, self).__init__() @@ -10339,6 +10567,8 @@ def read_many(reader): class MigrationPolicyReader(Reader): + """ + """ def __init__(self): super(MigrationPolicyReader, self).__init__() @@ -10411,6 +10641,8 @@ def read_many(reader): class NetworkReader(Reader): + """ + """ def __init__(self): super(NetworkReader, self).__init__() @@ -10548,6 +10780,8 @@ def _process_link(link, obj): class NetworkAttachmentReader(Reader): + """ + """ def __init__(self): super(NetworkAttachmentReader, self).__init__() @@ -10638,6 +10872,8 @@ def read_many(reader): class NetworkConfigurationReader(Reader): + """ + """ def __init__(self): super(NetworkConfigurationReader, self).__init__() @@ -10705,6 +10941,8 @@ def read_many(reader): class NetworkFilterReader(Reader): + """ + """ def __init__(self): super(NetworkFilterReader, self).__init__() @@ -10779,6 +11017,8 @@ def read_many(reader): class NetworkFilterParameterReader(Reader): + """ + """ def __init__(self): super(NetworkFilterParameterReader, self).__init__() @@ -10855,6 +11095,8 @@ def read_many(reader): class NetworkLabelReader(Reader): + """ + """ def __init__(self): super(NetworkLabelReader, self).__init__() @@ -10931,6 +11173,8 @@ def read_many(reader): class NfsProfileDetailReader(Reader): + """ + """ def __init__(self): super(NfsProfileDetailReader, self).__init__() @@ -10998,6 +11242,8 @@ def read_many(reader): class NicReader(Reader): + """ + """ def __init__(self): super(NicReader, self).__init__() @@ -11160,6 +11406,8 @@ def _process_link(link, obj): class NicConfigurationReader(Reader): + """ + """ def __init__(self): super(NicConfigurationReader, self).__init__() @@ -11235,6 +11483,8 @@ def read_many(reader): class NumaNodeReader(Reader): + """ + """ def __init__(self): super(NumaNodeReader, self).__init__() @@ -11334,6 +11584,8 @@ def _process_link(link, obj): class NumaNodePinReader(Reader): + """ + """ def __init__(self): super(NumaNodePinReader, self).__init__() @@ -11403,6 +11655,8 @@ def read_many(reader): class OpenStackImageReader(Reader): + """ + """ def __init__(self): super(OpenStackImageReader, self).__init__() @@ -11477,6 +11731,8 @@ def read_many(reader): class OpenStackImageProviderReader(Reader): + """ + """ def __init__(self): super(OpenStackImageProviderReader, self).__init__() @@ -11587,6 +11843,8 @@ def _process_link(link, obj): class OpenStackNetworkReader(Reader): + """ + """ def __init__(self): super(OpenStackNetworkReader, self).__init__() @@ -11661,6 +11919,8 @@ def read_many(reader): class OpenStackNetworkProviderReader(Reader): + """ + """ def __init__(self): super(OpenStackNetworkProviderReader, self).__init__() @@ -11798,6 +12058,8 @@ def _process_link(link, obj): class OpenStackProviderReader(Reader): + """ + """ def __init__(self): super(OpenStackProviderReader, self).__init__() @@ -11884,6 +12146,8 @@ def read_many(reader): class OpenStackSubnetReader(Reader): + """ + """ def __init__(self): super(OpenStackSubnetReader, self).__init__() @@ -11966,6 +12230,8 @@ def read_many(reader): class OpenStackVolumeProviderReader(Reader): + """ + """ def __init__(self): super(OpenStackVolumeProviderReader, self).__init__() @@ -12085,6 +12351,8 @@ def _process_link(link, obj): class OpenStackVolumeTypeReader(Reader): + """ + """ def __init__(self): super(OpenStackVolumeTypeReader, self).__init__() @@ -12161,6 +12429,8 @@ def read_many(reader): class OpenstackVolumeAuthenticationKeyReader(Reader): + """ + """ def __init__(self): super(OpenstackVolumeAuthenticationKeyReader, self).__init__() @@ -12243,6 +12513,8 @@ def read_many(reader): class OperatingSystemReader(Reader): + """ + """ def __init__(self): super(OperatingSystemReader, self).__init__() @@ -12322,6 +12594,8 @@ def read_many(reader): class OperatingSystemInfoReader(Reader): + """ + """ def __init__(self): super(OperatingSystemInfoReader, self).__init__() @@ -12402,6 +12676,8 @@ def read_many(reader): class OptionReader(Reader): + """ + """ def __init__(self): super(OptionReader, self).__init__() @@ -12471,6 +12747,8 @@ def read_many(reader): class PackageReader(Reader): + """ + """ def __init__(self): super(PackageReader, self).__init__() @@ -12536,6 +12814,8 @@ def read_many(reader): class PayloadReader(Reader): + """ + """ def __init__(self): super(PayloadReader, self).__init__() @@ -12605,6 +12885,8 @@ def read_many(reader): class PermissionReader(Reader): + """ + """ def __init__(self): super(PermissionReader, self).__init__() @@ -12699,6 +12981,8 @@ def read_many(reader): class PermitReader(Reader): + """ + """ def __init__(self): super(PermitReader, self).__init__() @@ -12775,6 +13059,8 @@ def read_many(reader): class PmProxyReader(Reader): + """ + """ def __init__(self): super(PmProxyReader, self).__init__() @@ -12840,6 +13126,8 @@ def read_many(reader): class PortMirroringReader(Reader): + """ + """ def __init__(self): super(PortMirroringReader, self).__init__() @@ -12897,6 +13185,8 @@ def read_many(reader): class PowerManagementReader(Reader): + """ + """ def __init__(self): super(PowerManagementReader, self).__init__() @@ -12982,6 +13272,8 @@ def read_many(reader): class ProductReader(Reader): + """ + """ def __init__(self): super(ProductReader, self).__init__() @@ -13054,6 +13346,8 @@ def read_many(reader): class ProductInfoReader(Reader): + """ + """ def __init__(self): super(ProductInfoReader, self).__init__() @@ -13125,6 +13419,8 @@ def read_many(reader): class ProfileDetailReader(Reader): + """ + """ def __init__(self): super(ProfileDetailReader, self).__init__() @@ -13198,6 +13494,8 @@ def read_many(reader): class PropertyReader(Reader): + """ + """ def __init__(self): super(PropertyReader, self).__init__() @@ -13265,6 +13563,8 @@ def read_many(reader): class ProxyTicketReader(Reader): + """ + """ def __init__(self): super(ProxyTicketReader, self).__init__() @@ -13330,6 +13630,8 @@ def read_many(reader): class QosReader(Reader): + """ + """ def __init__(self): super(QosReader, self).__init__() @@ -13438,6 +13740,8 @@ def read_many(reader): class QuotaReader(Reader): + """ + """ def __init__(self): super(QuotaReader, self).__init__() @@ -13557,6 +13861,8 @@ def _process_link(link, obj): class QuotaClusterLimitReader(Reader): + """ + """ def __init__(self): super(QuotaClusterLimitReader, self).__init__() @@ -13641,6 +13947,8 @@ def read_many(reader): class QuotaStorageLimitReader(Reader): + """ + """ def __init__(self): super(QuotaStorageLimitReader, self).__init__() @@ -13721,6 +14029,8 @@ def read_many(reader): class RangeReader(Reader): + """ + """ def __init__(self): super(RangeReader, self).__init__() @@ -13788,6 +14098,8 @@ def read_many(reader): class RateReader(Reader): + """ + """ def __init__(self): super(RateReader, self).__init__() @@ -13855,6 +14167,8 @@ def read_many(reader): class RegistrationAffinityGroupMappingReader(Reader): + """ + """ def __init__(self): super(RegistrationAffinityGroupMappingReader, self).__init__() @@ -13922,6 +14236,8 @@ def read_many(reader): class RegistrationAffinityLabelMappingReader(Reader): + """ + """ def __init__(self): super(RegistrationAffinityLabelMappingReader, self).__init__() @@ -13989,6 +14305,8 @@ def read_many(reader): class RegistrationClusterMappingReader(Reader): + """ + """ def __init__(self): super(RegistrationClusterMappingReader, self).__init__() @@ -14056,6 +14374,8 @@ def read_many(reader): class RegistrationConfigurationReader(Reader): + """ + """ def __init__(self): super(RegistrationConfigurationReader, self).__init__() @@ -14133,6 +14453,8 @@ def read_many(reader): class RegistrationDomainMappingReader(Reader): + """ + """ def __init__(self): super(RegistrationDomainMappingReader, self).__init__() @@ -14200,6 +14522,8 @@ def read_many(reader): class RegistrationLunMappingReader(Reader): + """ + """ def __init__(self): super(RegistrationLunMappingReader, self).__init__() @@ -14267,6 +14591,8 @@ def read_many(reader): class RegistrationRoleMappingReader(Reader): + """ + """ def __init__(self): super(RegistrationRoleMappingReader, self).__init__() @@ -14334,6 +14660,8 @@ def read_many(reader): class RegistrationVnicProfileMappingReader(Reader): + """ + """ def __init__(self): super(RegistrationVnicProfileMappingReader, self).__init__() @@ -14401,6 +14729,8 @@ def read_many(reader): class ReportedConfigurationReader(Reader): + """ + """ def __init__(self): super(ReportedConfigurationReader, self).__init__() @@ -14472,6 +14802,8 @@ def read_many(reader): class ReportedDeviceReader(Reader): + """ + """ def __init__(self): super(ReportedDeviceReader, self).__init__() @@ -14552,6 +14884,8 @@ def read_many(reader): class RngDeviceReader(Reader): + """ + """ def __init__(self): super(RngDeviceReader, self).__init__() @@ -14619,6 +14953,8 @@ def read_many(reader): class RoleReader(Reader): + """ + """ def __init__(self): super(RoleReader, self).__init__() @@ -14714,6 +15050,8 @@ def _process_link(link, obj): class SchedulingPolicyReader(Reader): + """ + """ def __init__(self): super(SchedulingPolicyReader, self).__init__() @@ -14823,6 +15161,8 @@ def _process_link(link, obj): class SchedulingPolicyUnitReader(Reader): + """ + """ def __init__(self): super(SchedulingPolicyUnitReader, self).__init__() @@ -14903,6 +15243,8 @@ def read_many(reader): class SeLinuxReader(Reader): + """ + """ def __init__(self): super(SeLinuxReader, self).__init__() @@ -14968,6 +15310,8 @@ def read_many(reader): class SerialNumberReader(Reader): + """ + """ def __init__(self): super(SerialNumberReader, self).__init__() @@ -15035,6 +15379,8 @@ def read_many(reader): class SessionReader(Reader): + """ + """ def __init__(self): super(SessionReader, self).__init__() @@ -15117,6 +15463,8 @@ def read_many(reader): class SkipIfConnectivityBrokenReader(Reader): + """ + """ def __init__(self): super(SkipIfConnectivityBrokenReader, self).__init__() @@ -15184,6 +15532,8 @@ def read_many(reader): class SkipIfSdActiveReader(Reader): + """ + """ def __init__(self): super(SkipIfSdActiveReader, self).__init__() @@ -15249,6 +15599,8 @@ def read_many(reader): class SnapshotReader(Reader): + """ + """ def __init__(self): super(SnapshotReader, self).__init__() @@ -15610,6 +15962,8 @@ def _process_link(link, obj): class SpecialObjectsReader(Reader): + """ + """ def __init__(self): super(SpecialObjectsReader, self).__init__() @@ -15677,6 +16031,8 @@ def read_many(reader): class SpmReader(Reader): + """ + """ def __init__(self): super(SpmReader, self).__init__() @@ -15744,6 +16100,8 @@ def read_many(reader): class SshReader(Reader): + """ + """ def __init__(self): super(SshReader, self).__init__() @@ -15826,6 +16184,8 @@ def read_many(reader): class SshPublicKeyReader(Reader): + """ + """ def __init__(self): super(SshPublicKeyReader, self).__init__() @@ -15902,6 +16262,8 @@ def read_many(reader): class SsoReader(Reader): + """ + """ def __init__(self): super(SsoReader, self).__init__() @@ -15967,6 +16329,8 @@ def read_many(reader): class StatisticReader(Reader): + """ + """ def __init__(self): super(StatisticReader, self).__init__() @@ -16065,6 +16429,8 @@ def read_many(reader): class StepReader(Reader): + """ + """ def __init__(self): super(StepReader, self).__init__() @@ -16176,6 +16542,8 @@ def _process_link(link, obj): class StorageConnectionReader(Reader): + """ + """ def __init__(self): super(StorageConnectionReader, self).__init__() @@ -16278,6 +16646,8 @@ def read_many(reader): class StorageConnectionExtensionReader(Reader): + """ + """ def __init__(self): super(StorageConnectionExtensionReader, self).__init__() @@ -16358,6 +16728,8 @@ def read_many(reader): class StorageDomainReader(Reader): + """ + """ def __init__(self): super(StorageDomainReader, self).__init__() @@ -16550,6 +16922,8 @@ def _process_link(link, obj): class StorageDomainLeaseReader(Reader): + """ + """ def __init__(self): super(StorageDomainLeaseReader, self).__init__() @@ -16615,6 +16989,8 @@ def read_many(reader): class SystemOptionReader(Reader): + """ + """ def __init__(self): super(SystemOptionReader, self).__init__() @@ -16689,6 +17065,8 @@ def read_many(reader): class SystemOptionValueReader(Reader): + """ + """ def __init__(self): super(SystemOptionValueReader, self).__init__() @@ -16756,6 +17134,8 @@ def read_many(reader): class TagReader(Reader): + """ + """ def __init__(self): super(TagReader, self).__init__() @@ -16840,6 +17220,8 @@ def read_many(reader): class TemplateReader(Reader): + """ + """ def __init__(self): super(TemplateReader, self).__init__() @@ -17078,6 +17460,8 @@ def _process_link(link, obj): class TemplateVersionReader(Reader): + """ + """ def __init__(self): super(TemplateVersionReader, self).__init__() @@ -17147,6 +17531,8 @@ def read_many(reader): class TicketReader(Reader): + """ + """ def __init__(self): super(TicketReader, self).__init__() @@ -17214,6 +17600,8 @@ def read_many(reader): class TimeZoneReader(Reader): + """ + """ def __init__(self): super(TimeZoneReader, self).__init__() @@ -17281,6 +17669,8 @@ def read_many(reader): class TransparentHugePagesReader(Reader): + """ + """ def __init__(self): super(TransparentHugePagesReader, self).__init__() @@ -17346,6 +17736,8 @@ def read_many(reader): class UnmanagedNetworkReader(Reader): + """ + """ def __init__(self): super(UnmanagedNetworkReader, self).__init__() @@ -17422,6 +17814,8 @@ def read_many(reader): class UsbReader(Reader): + """ + """ def __init__(self): super(UsbReader, self).__init__() @@ -17489,6 +17883,8 @@ def read_many(reader): class UserReader(Reader): + """ + """ def __init__(self): super(UserReader, self).__init__() @@ -17635,6 +18031,8 @@ def _process_link(link, obj): class UserOptionReader(Reader): + """ + """ def __init__(self): super(UserOptionReader, self).__init__() @@ -17711,6 +18109,8 @@ def read_many(reader): class ValueReader(Reader): + """ + """ def __init__(self): super(ValueReader, self).__init__() @@ -17778,6 +18178,8 @@ def read_many(reader): class VcpuPinReader(Reader): + """ + """ def __init__(self): super(VcpuPinReader, self).__init__() @@ -17845,6 +18247,8 @@ def read_many(reader): class VendorReader(Reader): + """ + """ def __init__(self): super(VendorReader, self).__init__() @@ -17917,6 +18321,8 @@ def read_many(reader): class VersionReader(Reader): + """ + """ def __init__(self): super(VersionReader, self).__init__() @@ -17999,6 +18405,8 @@ def read_many(reader): class VirtioScsiReader(Reader): + """ + """ def __init__(self): super(VirtioScsiReader, self).__init__() @@ -18064,6 +18472,8 @@ def read_many(reader): class VirtualNumaNodeReader(Reader): + """ + """ def __init__(self): super(VirtualNumaNodeReader, self).__init__() @@ -18169,6 +18579,8 @@ def _process_link(link, obj): class VlanReader(Reader): + """ + """ def __init__(self): super(VlanReader, self).__init__() @@ -18229,6 +18641,8 @@ def read_many(reader): class VmReader(Reader): + """ + """ def __init__(self): super(VmReader, self).__init__() @@ -18573,6 +18987,8 @@ def _process_link(link, obj): class VmBaseReader(Reader): + """ + """ def __init__(self): super(VmBaseReader, self).__init__() @@ -18739,6 +19155,8 @@ def read_many(reader): class VmMediatedDeviceReader(Reader): + """ + """ def __init__(self): super(VmMediatedDeviceReader, self).__init__() @@ -18836,6 +19254,8 @@ def _process_link(link, obj): class VmPlacementPolicyReader(Reader): + """ + """ def __init__(self): super(VmPlacementPolicyReader, self).__init__() @@ -18918,6 +19338,8 @@ def _process_link(link, obj): class VmPoolReader(Reader): + """ + """ def __init__(self): super(VmPoolReader, self).__init__() @@ -19037,6 +19459,8 @@ def _process_link(link, obj): class VmSummaryReader(Reader): + """ + """ def __init__(self): super(VmSummaryReader, self).__init__() @@ -19106,6 +19530,8 @@ def read_many(reader): class VnicPassThroughReader(Reader): + """ + """ def __init__(self): super(VnicPassThroughReader, self).__init__() @@ -19171,6 +19597,8 @@ def read_many(reader): class VnicProfileReader(Reader): + """ + """ def __init__(self): super(VnicProfileReader, self).__init__() @@ -19276,6 +19704,8 @@ def _process_link(link, obj): class VnicProfileMappingReader(Reader): + """ + """ def __init__(self): super(VnicProfileMappingReader, self).__init__() @@ -19345,6 +19775,8 @@ def read_many(reader): class VolumeGroupReader(Reader): + """ + """ def __init__(self): super(VolumeGroupReader, self).__init__() @@ -19415,6 +19847,8 @@ def read_many(reader): class WatchdogReader(Reader): + """ + """ def __init__(self): super(WatchdogReader, self).__init__() @@ -19514,6 +19948,8 @@ def _process_link(link, obj): class WeightReader(Reader): + """ + """ def __init__(self): super(WeightReader, self).__init__() diff --git a/lib/ovirtsdk4/service.py b/lib/ovirtsdk4/service.py index 8a11d16..da781f4 100644 --- a/lib/ovirtsdk4/service.py +++ b/lib/ovirtsdk4/service.py @@ -36,10 +36,13 @@ def __init__(self, connection, context, code): """ Creates a new future result. - `connection`:: The connection to be used by this future. - `context`:: The request that this future will wait for when the `wait` + `connection` \n + The connection to be used by this future. + `context` \n + The request that this future will wait for when the `wait` method is called. - `code`:: The function that will be executed to check the response, and + `code` \n + The function that will be executed to check the response, and to convert its body into the right type of object. """ self._connection = connection diff --git a/lib/ovirtsdk4/services.py b/lib/ovirtsdk4/services.py index e242f8e..06e1962 100644 --- a/lib/ovirtsdk4/services.py +++ b/lib/ovirtsdk4/services.py @@ -46,27 +46,30 @@ def get( ): """ Retrieve the affinity group details. - [source,xml] - ---- + ```xml AF_GROUP_001 true true - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -91,21 +94,22 @@ def remove( ): """ Remove the affinity group. - [source] - ---- + ``` DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456 - ---- - - + ``` This method supports the following parameters: - `async_`:: Indicates if the removal should be performed asynchronously. + `async_` \n + Indicates if the removal should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -140,13 +144,14 @@ def update( This method supports the following parameters: - `group`:: The affinity group. - - `headers`:: Additional HTTP headers. - - `query`:: Additional URL query parameters. - - `wait`:: If `True` wait for the response. + `group` \n + The affinity group. + `headers` \n + Additional HTTP headers. + `query` \n + Additional URL query parameters. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -254,13 +259,17 @@ def remove( This method supports the following parameters: - `async_`:: Indicates if the removal should be performed asynchronously. + `async_` \n + Indicates if the removal should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -315,13 +324,17 @@ def remove( This method supports the following parameters: - `async_`:: Indicates if the removal should be performed asynchronously. + `async_` \n + Indicates if the removal should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -375,25 +388,27 @@ def add( Adds a host label to the affinity group. For example, to add the label `789` to the affinity group `456` of cluster `123`, send a request like this: - .... + ``` POST /ovirt-engine/api/clusters/123/affinitygroups/456/hostlabels - .... + ``` With the following body: - [source,xml] - ---- + ```xml - ---- - + ``` This method supports the following parameters: - `label`:: The AffinityLabel object to add to the affinity group. + `label` \n + The AffinityLabel object to add to the affinity group. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -419,20 +434,24 @@ def list( List all host labels assigned to this affinity group. The order of the returned labels isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of host labels to return. + `max` \n + Sets the maximum number of host labels to return. If not specified, all the labels are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -498,25 +517,27 @@ def add( Adds a host to the affinity group. For example, to add the host `789` to the affinity group `456` of cluster `123`, send a request like this: - .... + ``` POST /ovirt-engine/api/clusters/123/affinitygroups/456/hosts - .... + ``` With the following body: - [source,xml] - ---- + ```xml - ---- - + ``` This method supports the following parameters: - `host`:: The host to be added to the affinity group. + `host` \n + The host to be added to the affinity group. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -542,20 +563,23 @@ def list( List all hosts assigned to this affinity group. The order of the returned hosts isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of hosts to return. If not specified, all the hosts are - returned. + `max` \n + Sets the maximum number of hosts to return. If not specified, all the hosts are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -622,13 +646,17 @@ def remove( This method supports the following parameters: - `async_`:: Indicates if the removal should be performed asynchronously. + `async_` \n + Indicates if the removal should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -683,13 +711,17 @@ def remove( This method supports the following parameters: - `async_`:: Indicates if the removal should be performed asynchronously. + `async_` \n + Indicates if the removal should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -743,25 +775,28 @@ def add( Adds a virtual machine label to the affinity group. For example, to add the label `789` to the affinity group `456` of cluster `123`, send a request like this: - .... + ``` POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmlabels - .... + ``` With the following body: - [source,xml] - ---- + ```xml - ---- + ``` This method supports the following parameters: - `label`:: The AffinityLabel object to add to the affinity group. + `label` \n + The AffinityLabel object to add to the affinity group. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -787,20 +822,24 @@ def list( List all virtual machine labels assigned to this affinity group. The order of the returned labels isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of virtual machine labels to return. + `max` \n + Sets the maximum number of virtual machine labels to return. If not specified, all the labels are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -822,7 +861,6 @@ def list( def label_service(self, id): """ Access the service that manages the virtual machine label assignment to this affinity group. - """ Service._check_types([ ('id', id, str), @@ -847,7 +885,6 @@ def __str__(self): class AffinityGroupVmsService(Service): """ This service manages a collection of all the virtual machines assigned to an affinity group. - """ def __init__(self, connection, path): @@ -866,16 +903,13 @@ def add( Adds a virtual machine to the affinity group. For example, to add the virtual machine `789` to the affinity group `456` of cluster `123`, send a request like this: - .... + ``` POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms - .... + ``` With the following body: - [source,xml] - ---- + ```xml - ---- - - + ``` """ # Check the types of the parameters: Service._check_types([ @@ -901,20 +935,23 @@ def list( List all virtual machines assigned to this affinity group. The order of the returned virtual machines isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of virtual machines to return. If not specified, all the virtual machines are - returned. + `max` \n + Sets the maximum number of virtual machines to return. If not specified, all the virtual machines are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -936,7 +973,6 @@ def list( def vm_service(self, id): """ Access the service that manages the virtual machine assignment to this affinity group. - """ Service._check_types([ ('id', id, str), @@ -961,7 +997,6 @@ def __str__(self): class AffinityGroupsService(Service): """ The affinity groups service manages virtual machine relationships and dependencies. - """ def __init__(self, connection, path): @@ -979,13 +1014,11 @@ def add( """ Create a new affinity group. Post a request like in the example below to create a new affinity group: - [source] - ---- + ``` POST /ovirt-engine/api/clusters/000-000/affinitygroups - ---- + ``` And use the following example in its body: - [source,xml] - ---- + ```xml AF_GROUP_001 @@ -996,18 +1029,21 @@ def add( false - ---- - + ``` This method supports the following parameters: - `group`:: The affinity group object to create. + `group` \n + The affinity group object to create. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1033,19 +1069,23 @@ def list( List existing affinity groups. The order of the affinity groups results isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of affinity groups to return. If not specified all the affinity groups are returned. + `max` \n + Sets the maximum number of affinity groups to return. If not specified all the affinity groups are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1067,7 +1107,6 @@ def list( def group_service(self, id): """ Access the affinity group service that manages the affinity group specified by an ID. - """ Service._check_types([ ('id', id, str), @@ -1092,7 +1131,6 @@ def __str__(self): class AffinityLabelService(Service): """ The details of a single affinity label. - """ def __init__(self, connection, path): @@ -1111,17 +1149,20 @@ def get( """ Retrieves the details of a label. - This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1146,8 +1187,6 @@ def remove( """ Removes a label from the system and clears all assignments of the removed label. - - """ # Check the types of the parameters: Service._check_types([ @@ -1170,8 +1209,6 @@ def update( """ Updates a label. This call will update all metadata, such as the name or description. - - """ # Check the types of the parameters: Service._check_types([ @@ -1187,14 +1224,12 @@ def update( def hosts_service(self): """ List all hosts with this label. - """ return AffinityLabelHostsService(self._connection, '%s/hosts' % self._path) def vms_service(self): """ List all virtual machines with this label. - """ return AffinityLabelVmsService(self._connection, '%s/vms' % self._path) @@ -1223,9 +1258,7 @@ class AffinityLabelHostService(Service): This service represents a host that has a specific label when accessed through the affinitylabels/hosts subcollection. - """ - def __init__(self, connection, path): super(AffinityLabelHostService, self).__init__(connection, path) @@ -1240,17 +1273,20 @@ def get( """ Retrieves details about a host that has this label assigned. - This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1274,8 +1310,6 @@ def remove( ): """ Remove a label from a host. - - """ # Check the types of the parameters: Service._check_types([ @@ -1304,7 +1338,6 @@ class AffinityLabelHostsService(Service): This service represents list of hosts that have a specific label when accessed through the affinitylabels/hosts subcollection. - """ def __init__(self, connection, path): @@ -1321,8 +1354,6 @@ def add( ): """ Add a label to a host. - - """ # Check the types of the parameters: Service._check_types([ @@ -1347,17 +1378,20 @@ def list( List all hosts with the label. The order of the returned hosts isn't guaranteed. - This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1376,7 +1410,6 @@ def host_service(self, id): """ A link to the specific label-host assignment to allow label removal. - """ Service._check_types([ ('id', id, str), @@ -1403,7 +1436,6 @@ class AffinityLabelVmService(Service): This service represents a vm that has a specific label when accessed through the affinitylabels/vms subcollection. - """ def __init__(self, connection, path): @@ -1420,17 +1452,20 @@ def get( """ Retrieves details about a vm that has this label assigned. - This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1454,8 +1489,6 @@ def remove( ): """ Remove a label from a vm. - - """ # Check the types of the parameters: Service._check_types([ @@ -1484,7 +1517,6 @@ class AffinityLabelVmsService(Service): This service represents list of vms that have a specific label when accessed through the affinitylabels/vms subcollection. - """ def __init__(self, connection, path): @@ -1501,8 +1533,6 @@ def add( ): """ Add a label to a vm. - - """ # Check the types of the parameters: Service._check_types([ @@ -1527,17 +1557,20 @@ def list( List all virtual machines with the label. The order of the returned virtual machines isn't guaranteed. - This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1556,7 +1589,6 @@ def vm_service(self, id): """ A link to the specific label-vm assignment to allow label removal. - """ Service._check_types([ ('id', id, str), @@ -1581,7 +1613,6 @@ def __str__(self): class AffinityLabelsService(Service): """ Manages the affinity labels available in the system. - """ def __init__(self, connection, path): @@ -1599,8 +1630,6 @@ def add( """ Creates a new label. The label is automatically attached to all entities mentioned in the vms or hosts lists. - - """ # Check the types of the parameters: Service._check_types([ @@ -1626,19 +1655,23 @@ def list( Lists all labels present in the system. The order of the returned labels isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of labels to return. If not specified all the labels are returned. + `max` \n + Sets the maximum number of labels to return. If not specified all the labels are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1660,7 +1693,6 @@ def list( def label_service(self, id): """ Link to a single label details. - """ Service._check_types([ ('id', id, str), @@ -1694,7 +1726,6 @@ class AreaService(Service): A concept may be associated to more than one area, or to no area. The value of this annotation is intended for reporting only, and it doesn't affect at all the generated code or the validity of the model - """ def __init__(self, connection, path): @@ -1716,7 +1747,6 @@ class AssignedAffinityLabelService(Service): """ This service represents one label to entity assignment when accessed using the entities/affinitylabels subcollection. - """ def __init__(self, connection, path): @@ -1733,17 +1763,20 @@ def get( """ Retrieves details about the attached label. - This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1767,8 +1800,6 @@ def remove( ): """ Removes the label from an entity. Does not touch the label itself. - - """ # Check the types of the parameters: Service._check_types([ @@ -1796,7 +1827,6 @@ class AssignedAffinityLabelsService(Service): """ This service is used to list and manipulate affinity labels that are assigned to supported entities when accessed using entities/affinitylabels. - """ def __init__(self, connection, path): @@ -1813,8 +1843,6 @@ def add( ): """ Attaches a label to an entity. - - """ # Check the types of the parameters: Service._check_types([ @@ -1839,17 +1867,20 @@ def list( Lists all labels that are attached to an entity. The order of the returned entities isn't guaranteed. - This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1868,7 +1899,6 @@ def label_service(self, id): """ Link to the specific entity-label assignment to allow removal. - """ Service._check_types([ ('id', id, str), @@ -1908,14 +1938,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1941,13 +1975,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -1997,8 +2035,6 @@ def add( ): """ Add a new cpu profile for the cluster. - - """ # Check the types of the parameters: Service._check_types([ @@ -2024,19 +2060,23 @@ def list( List the CPU profiles assigned to the cluster. The order of the returned CPU profiles isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of profiles to return. If not specified all the profiles are returned. + `max` \n + Sets the maximum number of profiles to return. If not specified all the profiles are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2056,8 +2096,6 @@ def list( return self._internal_get(headers, query, wait) def profile_service(self, id): - """ - """ Service._check_types([ ('id', id, str), ]) @@ -2096,14 +2134,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2129,13 +2171,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2185,8 +2231,6 @@ def add( ): """ Add a new disk profile for the storage domain. - - """ # Check the types of the parameters: Service._check_types([ @@ -2212,19 +2256,23 @@ def list( Returns the list of disk profiles assigned to the storage domain. The order of the returned disk profiles isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of profiles to return. If not specified all the profiles are returned. + `max` \n + Sets the maximum number of profiles to return. If not specified all the profiles are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2269,7 +2317,6 @@ def __str__(self): class AssignedPermissionsService(Service): """ Represents a permission sub-collection, scoped by user, group or some entity type. - """ def __init__(self, connection, path): @@ -2288,60 +2335,59 @@ def add( Assign a new permission to a user or group for specific entity. For example, to assign the `UserVmManager` role to the virtual machine with id `123` to the user with id `456` send a request like this: - .... + ``` POST /ovirt-engine/api/vms/123/permissions - .... + ``` With a request body like this: - [source,xml] - ---- + ```xml UserVmManager - ---- + ``` To assign the `SuperUser` role to the system to the user with id `456` send a request like this: - .... + ``` POST /ovirt-engine/api/permissions - .... + ``` With a request body like this: - [source,xml] - ---- + ```xml SuperUser - ---- + ``` If you want to assign permission to the group instead of the user please replace the `user` element with the `group` element with proper `id` of the group. For example to assign the `UserRole` role to the cluster with id `123` to the group with id `789` send a request like this: - .... + ``` POST /ovirt-engine/api/clusters/123/permissions - .... + ``` With a request body like this: - [source,xml] - ---- + ```xml UserRole - ---- - - + ``` This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2365,16 +2411,19 @@ def add_cluster_permission( """ Add a new permission on the cluster to the group in the system. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2398,16 +2447,19 @@ def add_data_center_permission( """ Add a new permission on the data center to the group in the system. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2431,16 +2483,19 @@ def add_group_level( """ Add a new group level permission for a given virtual machine. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2464,16 +2519,19 @@ def add_host_permission( """ Add a new permission on the host to the group in the system. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2497,11 +2555,11 @@ def list( """ List all the permissions of the specific entity. For example to list all the permissions of the cluster with id `123` send a request like this: - .... + ``` GET /ovirt-engine/api/clusters/123/permissions - .... - [source,xml] - ---- + ``` + With a request body like this: + ```xml @@ -2514,20 +2572,23 @@ def list( - ---- + ``` The order of the returned permissions isn't guaranteed. - This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2553,16 +2614,19 @@ def add_storage_domain_permission( """ Add a new permission on the storage domain to the group in the system. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2586,16 +2650,19 @@ def add_template_permission( """ Add a new permission on the template to the group in the system. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2619,16 +2686,19 @@ def add_user_level( """ Add a new user level permission for a given virtual machine. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2652,16 +2722,19 @@ def add_vm_permission( """ Add a new permission on the vm to the group in the system. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2685,16 +2758,19 @@ def add_vm_pool_permission( """ Add a new permission on the vm pool to the group in the system. - This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2711,7 +2787,6 @@ def permission_service(self, id): """ Sub-resource locator method, returns individual permission resource on which the remainder of the URI is dispatched. - """ Service._check_types([ ('id', id, str), @@ -2736,7 +2811,6 @@ def __str__(self): class AssignedRolesService(Service): """ Represents a roles sub-collection, for example scoped by user. - """ def __init__(self, connection, path): @@ -2756,19 +2830,23 @@ def list( Returns the roles assigned to the permission. The order of the returned roles isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of roles to return. If not specified all the roles are returned. + `max` \n + Sets the maximum number of roles to return. If not specified all the roles are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2790,7 +2868,6 @@ def list( def role_service(self, id): """ Sub-resource locator method, returns individual role resource on which the remainder of the URI is dispatched. - """ Service._check_types([ ('id', id, str), @@ -2815,7 +2892,6 @@ def __str__(self): class AssignedTagService(Service): """ A service to manage assignment of specific tag to specific entities in system. - """ def __init__(self, connection, path): @@ -2833,29 +2909,31 @@ def get( Gets the information about the assigned tag. For example to retrieve the information about the tag with the id `456` which is assigned to virtual machine with id `123` send a request like this: - .... + ``` GET /ovirt-engine/api/vms/123/tags/456 - .... - [source,xml] - ---- + ``` + results in a response body like this: + ```xml root root - ---- - - + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2881,20 +2959,23 @@ def remove( """ Unassign tag from specific entity in the system. For example to unassign the tag with id `456` from virtual machine with id `123` send a request like this: - .... + ``` DELETE /ovirt-engine/api/vms/123/tags/456 - .... - + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2947,27 +3028,30 @@ def add( """ Assign tag to specific entity in the system. For example to assign tag `mytag` to virtual machine with the id `123` send a request like this: - .... + ``` POST /ovirt-engine/api/vms/123/tags - .... + ``` With a request body like this: - [source,xml] - ---- + ```xml mytag - ---- + ``` This method supports the following parameters: - `tag`:: The assigned tag. + `tag` \n + The assigned tag. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -2992,11 +3076,11 @@ def list( """ List all tags assigned to the specific entity. For example to list all the tags of the virtual machine with id `123` send a request like this: - .... + ``` GET /ovirt-engine/api/vms/123/tags - .... - [source,xml] - ---- + ``` + Results in a response body like this: + ```xml mytag @@ -3004,22 +3088,26 @@ def list( - ---- + ``` The order of the returned tags isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of tags to return. If not specified all the tags are returned. + `max` \n + Sets the maximum number of tags to return. If not specified all the tags are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3041,7 +3129,6 @@ def list( def tag_service(self, id): """ Reference to the service that manages assignment of specific tag. - """ Service._check_types([ ('id', id, str), @@ -3082,14 +3169,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3115,13 +3206,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3142,8 +3237,6 @@ def remove( self._internal_remove(headers, query, wait) def permissions_service(self): - """ - """ return AssignedPermissionsService(self._connection, '%s/permissions' % self._path) def service(self, path): @@ -3180,8 +3273,6 @@ def add( ): """ Add a new virtual network interface card profile for the network. - - """ # Check the types of the parameters: Service._check_types([ @@ -3207,19 +3298,23 @@ def list( Returns the list of VNIC profiles assifned to the network. The order of the returned VNIC profiles isn't guaranteed. - This method supports the following parameters: - `max`:: Sets the maximum number of profiles to return. If not specified all the profiles are returned. + `max` \n + Sets the maximum number of profiles to return. If not specified all the profiles are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3239,8 +3334,6 @@ def list( return self._internal_get(headers, query, wait) def profile_service(self, id): - """ - """ Service._check_types([ ('id', id, str), ]) @@ -3280,27 +3373,28 @@ def activate( """ This operation activates an attached storage domain. Once the storage domain is activated it is ready for use with the data center. - [source] - ---- + ``` POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate - ---- + ``` The activate action does not take any action specific parameters, so the request body should contain an empty `action`: - [source,xml] - ---- + ```xml - ---- - + ``` This method supports the following parameters: - `async_`:: Indicates if the activation should be performed asynchronously. + `async_` \n + Indicates if the activation should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3332,45 +3426,53 @@ def deactivate( This operation deactivates an attached storage domain. Once the storage domain is deactivated it will not be used with the data center. For example, to deactivate storage domain `456`, send the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate - ---- + ``` + With a request body like this: - [source,xml] - ---- + + ```xml - ---- + ``` + If the `force` parameter is `true` then the operation will succeed, even if the OVF update which takes place before the deactivation of the storage domain failed. If the `force` parameter is `false` and the OVF update failed, the deactivation of the storage domain will also fail. - This method supports the following parameters: - `async_`:: Indicates if the deactivation should be performed asynchronously. + `async_` \n + Indicates if the deactivation should be performed asynchronously. - `force`:: Indicates if the operation should succeed and the storage domain should be moved to a deactivated state, even if + `force` \n + Indicates if the operation should succeed and the storage domain should be moved to a deactivated state, even if the OVF update for the storage domain failed. + For example, to deactivate storage domain `456` using force flag, send the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate - ---- + ``` + With a request body like this: - [source,xml] - ---- + + ``` true - ---- + ``` This parameter is optional, and the default value is `false`. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3402,14 +3504,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3435,13 +3541,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3504,21 +3614,24 @@ def add( """ Adds or registers a disk. IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. To add a new disk use the xref:services-disks-methods-add[add] + compatibility. It will be removed in the future. To add a new disk use the `DisksService.add` operation of the service that manages the disks of the system. To register an unregistered disk use the - xref:services-attached_storage_domain_disk-methods-register[register] operation of the service that manages - that disk. + `AttachedStorageDomainDiskService.register` operation of the service that manages that disk. This method supports the following parameters: - `disk`:: The disk to add or register. + `disk` \n + The disk to add or register. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3550,16 +3663,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of disks to return. If not specified all the disks are returned. + `max` \n + Sets the maximum number of disks to return. If not specified all the disks are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3627,13 +3745,17 @@ def add( This method supports the following parameters: - `storage_domain`:: The storage domain to attach to the data center. + `storage_domain` \n + The storage domain to attach to the data center. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3662,16 +3784,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of storage domains to return. If not specified all the storage domains are returned. + `max` \n + Sets the maximum number of storage domains to return. If not specified all the storage domains are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3732,16 +3859,21 @@ def get( """ This method supports the following parameters: - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3771,13 +3903,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3858,18 +3994,24 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of balances to return. If not specified all the balances are returned. + `max` \n + Sets the maximum number of balances to return. If not specified all the balances are returned. - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3935,29 +4077,33 @@ def get( """ Get a bookmark. An example for getting a bookmark: - [source] - ---- + + ``` GET /ovirt-engine/api/bookmarks/123 - ---- - [source,xml] - ---- + ``` + + ```xml example_vm vm: name=example* - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -3983,21 +4129,25 @@ def remove( """ Remove a bookmark. An example for removing a bookmark: - [source] - ---- + + ``` DELETE /ovirt-engine/api/bookmarks/123 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4029,29 +4179,33 @@ def update( """ Update a bookmark. An example for updating a bookmark: - [source] - ---- + + ``` PUT /ovirt-engine/api/bookmarks/123 - ---- + ``` With the request body: - [source,xml] - ---- + + ```xml new_example_vm vm: name=new_example* - ---- + ``` This method supports the following parameters: - `bookmark`:: The updated bookmark. + `bookmark` \n + The updated bookmark. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4105,28 +4259,32 @@ def add( """ Adding a new bookmark. Example of adding a bookmark: - [source] - ---- + + ``` POST /ovirt-engine/api/bookmarks - ---- - [source,xml] - ---- + ``` + + ```xml new_example_vm vm: name=new_example* - ---- + ``` This method supports the following parameters: - `bookmark`:: The added bookmark. + `bookmark` \n + The added bookmark. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4151,12 +4309,13 @@ def list( """ Listing all the available bookmarks. Example of listing bookmarks: - [source] - ---- + + ``` GET /ovirt-engine/api/bookmarks - ---- - [source,xml] - ---- + ``` + The response will be similar to: + + ```xml database @@ -4167,22 +4326,27 @@ def list( vm: name=example* - ---- + ``` The order of the returned bookmarks isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned. + `max` \n + Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4256,12 +4420,12 @@ def get( """ Gets information about the cluster. An example of getting a cluster: - [source] - ---- + + ``` GET /ovirt-engine/api/clusters/123 - ---- - [source,xml] - ---- + ``` + + ```xml @@ -4327,21 +4491,26 @@ def get( true - ---- + ``` This method supports the following parameters: - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4371,10 +4540,10 @@ def refresh_gluster_heal_status( Refresh the Gluster heal info for all volumes in cluster. For example, Cluster `123`, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/clusters/123/refreshglusterhealstatus - ---- + ``` """ @@ -4399,21 +4568,25 @@ def remove( ): """ Removes the cluster from the system. - [source] - ---- + + ``` DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4444,13 +4617,17 @@ def reset_emulated_machine( """ This method supports the following parameters: - `async_`:: Indicates if the reset should be performed asynchronously. + `async_` \n + Indicates if the reset should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4479,26 +4656,30 @@ def sync_all_networks( ): """ Synchronizes all networks on the cluster. - [source] - ---- + + ``` POST /ovirt-engine/api/clusters/123/syncallnetworks - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4530,19 +4711,19 @@ def update( Updates information about the cluster. Only the specified fields are updated; others remain unchanged. For example, to update the cluster's CPU: - [source] - ---- + + ``` PUT /ovirt-engine/api/clusters/123 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml Intel Haswell-noTSX Family - ---- + ``` """ @@ -4580,22 +4761,22 @@ def upgrade( Start, update or finish upgrade process for the cluster based on the action value. This action marks the cluster for upgrade, updates the progress, or clears the upgrade running flag on the cluster based on the action value which takes values of `start`, `stop` or `update_progress`. - [source] - ---- + + ``` POST /ovirt-engine/api/clusters/123/upgrade - ---- + ``` With a request body like this to mark the cluster for upgrade: - [source,xml] - ---- + + ```xml start - ---- + ``` After starting the upgrade, use a request body like this to update the progress to 15%: - [source,xml] - ---- + + ```xml update_progress @@ -4604,26 +4785,33 @@ def upgrade( 15 - ---- + ``` This method supports the following parameters: - `upgrade_action`:: The action to be performed. + `upgrade_action` \n + The action to be performed. - `correlation_id`:: Explicitly set the upgrade correlation identifier. Use to correlate events + `correlation_id` \n + Explicitly set the upgrade correlation identifier. Use to correlate events detailing the cluster upgrade to the upgrade itself. If not specificed, the correlation id from `Correlation-Id` http header will be used. - `upgrade_percent_complete`:: Update the upgrade's progress as a percent complete of the total process. + `upgrade_percent_complete` \n + Update the upgrade's progress as a percent complete of the total process. - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4779,29 +4967,33 @@ def get( """ Provides the information about the cluster feature enabled. For example, to find details of the enabled feature `456` for cluster `123`, send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/clusters/123/enabledfeatures/456 - ---- - That will return a xref:types-cluster_feature[ClusterFeature] object containing the name: - [source,xml] - ---- + ``` + That will return a `ovirtsdk4.types.ClusterFeature` object containing the name: + + ```xml libgfapi_supported - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -4826,10 +5018,10 @@ def remove( """ Disables a cluster feature. For example, to disable the feature `456` of cluster `123` send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456 - ---- + ``` """ @@ -4877,17 +5069,15 @@ def add( """ Enable an additional feature for a cluster. For example, to enable a feature `456` on cluster `123`, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/clusters/123/enabledfeatures - ---- + ``` The request body should look like this: - [source,xml] - ---- - - ---- - + ```xml + + ``` """ # Check the types of the parameters: Service._check_types([ @@ -4911,32 +5101,36 @@ def list( """ Lists the additional features enabled for the cluster. For example, to get the features enabled for cluster `123` send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/clusters/123/enabledfeatures - ---- + ``` This will return a list of features: - [source,xml] - ---- + + ```xml test_feature ... - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5001,14 +5195,18 @@ def list( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5055,29 +5253,33 @@ def get( """ Provides the information about the a cluster feature supported by a cluster level. For example, to find details of the cluster feature `456` for cluster level 4.1, send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456 - ---- - That will return a xref:types-cluster_feature[ClusterFeature] object containing the name: - [source,xml] - ---- + ``` + That will return a `ovirtsdk4.types.ClusterFeature` object containing the name: + + ```xml libgfapi_supported - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5124,32 +5326,36 @@ def list( ): """ Lists the cluster features supported by the cluster level. - [source] - ---- + + ``` GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures - ---- + ``` This will return a list of cluster features supported by the cluster level: - [source,xml] - ---- + + ```xml test_feature ... - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5191,9 +5397,8 @@ def __str__(self): class ClusterLevelService(Service): """ - Provides information about a specific cluster level. See the xref:services-cluster_levels[ClusterLevels] service for + Provides information about a specific cluster level. See the `ClusterLevelsService` service for more information. - """ def __init__(self, connection, path): @@ -5211,14 +5416,14 @@ def get( """ Provides the information about the capabilities of the specific cluster level managed by this service. For example, to find what CPU types are supported by level 3.6 you can send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/clusterlevels/3.6 - ---- - That will return a xref:types-cluster_level[ClusterLevel] object containing the supported CPU types, and other + ``` + That will return a `ovirtsdk4.types.ClusterLevel` object containing the supported CPU types, and other information which describes the cluster level: - [source,xml] - ---- + + ```xml @@ -5236,19 +5441,23 @@ def get( ... - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5308,33 +5517,37 @@ def list( ): """ Lists the cluster levels supported by the system. - [source] - ---- + + ``` GET /ovirt-engine/api/clusterlevels - ---- + ``` This will return a list of available cluster levels. - [source,xml] - ---- + + ```xml ... ... - ---- + ``` The order of the returned cluster levels isn't guaranteed. This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5397,14 +5610,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5455,13 +5672,17 @@ def update( This method supports the following parameters: - `network`:: The cluster network. + `network` \n + The cluster network. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5507,26 +5728,30 @@ def add( """ Assigns the network to a cluster. Post a request like in the example below to assign the network to a cluster: - [source] - ---- + + ``` POST /ovirt-engine/api/clusters/123/networks - ---- + ``` Use the following example in its body: - [source,xml] - ---- + + ```xml - ---- + ``` This method supports the following parameters: - `network`:: The network object to be assigned to the cluster. + `network` \n + The network object to be assigned to the cluster. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5555,16 +5780,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of networks to return. If not specified, all the networks are returned. + `max` \n + Sets the maximum number of networks to return. If not specified, all the networks are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5630,13 +5860,13 @@ def add( Creates a new cluster. This requires the `name`, `cpu.type`, and `data_center` attributes. Identify the data center with either the `id` or `name` attribute. - [source] - ---- + + ``` POST /ovirt-engine/api/clusters - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml mycluster @@ -5644,16 +5874,16 @@ def add( - ---- + ``` To create a cluster with an external network provider to be deployed on every host that is added to the cluster, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/clusters - ---- + ``` With a request body containing a reference to the desired provider: - [source,xml] - ---- + + ```xml mycluster @@ -5664,7 +5894,7 @@ def add( - ---- + ``` """ @@ -5699,24 +5929,32 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of clusters to return. If not specified, all the clusters are returned. + `max` \n + Sets the maximum number of clusters to return. If not specified, all the clusters are returned. - `search`:: A query string used to restrict the returned clusters. + `search` \n + A query string used to restrict the returned clusters. - `case_sensitive`:: Indicates if the search should be performed taking case into account. + `case_sensitive` \n + Indicates if the search should be performed taking case into account. The default value is `true`, which means that case is taken into account. To search ignoring case, set it to `false`. - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5789,13 +6027,17 @@ def copy( """ This method supports the following parameters: - `async_`:: Indicates if the copy should be performed asynchronously. + `async_` \n + Indicates if the copy should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5845,14 +6087,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5878,13 +6124,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -5915,8 +6165,6 @@ def update( ): """ Update the specified cpu profile in the system. - - """ # Check the types of the parameters: Service._check_types([ @@ -6006,16 +6254,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of profiles to return. If not specified, all the profiles are returned. + `max` \n + Sets the maximum number of profiles to return. If not specified, all the profiles are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6086,26 +6339,30 @@ def clean_finished_tasks( switch to another host if the SPM has uncleared tasks. Clearing all finished tasks enables the SPM switching. For example, to clean all the finished tasks on a data center with ID `123` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/cleanfinishedtasks - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6136,12 +6393,12 @@ def get( """ Get a data center. An example of getting a data center: - [source] - ---- + + ``` GET /ovirt-engine/api/datacenters/123 - ---- - [source,xml] - ---- + ``` + + ```xml Default The default Data Center @@ -6168,21 +6425,26 @@ def get( - ---- + ``` This method supports the following parameters: - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6212,10 +6474,10 @@ def remove( ): """ Removes the data center. - [source] - ---- + + ``` DELETE /ovirt-engine/api/datacenters/123 - ---- + ``` Without any special parameters, the storage domains attached to the data center are detached and then removed from the storage. If something fails when performing this operation, for example if there is no host available to remove the storage domains from the storage, the complete operation will fail. @@ -6226,17 +6488,22 @@ def remove( This method supports the following parameters: - `force`:: Indicates if the operation should succeed, and the storage domain removed from the database, even if + `force` \n + Indicates if the operation should succeed, and the storage domain removed from the database, even if something fails during the operation. This parameter is optional, and the default value is `false`. - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6273,31 +6540,36 @@ def set_master( Used for manually setting a storage domain in the data center as a master. For example, for setting a storage domain with ID '456' as a master on a data center with ID '123', send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/setmaster - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml - ---- + ``` The new master storage domain can be also specified by its name. This method supports the following parameters: - `storage_domain`:: The new master storage domain for the data center. + `storage_domain` \n + The new master storage domain for the data center. - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6331,29 +6603,33 @@ def update( Updates the data center. The `name`, `description`, `storage_type`, `version`, `storage_format` and `mac_pool` elements are updatable post-creation. For example, to change the name and description of data center `123` send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/datacenters/123 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml myupdatedname An updated description for the data center - ---- + ``` This method supports the following parameters: - `data_center`:: The data center that is being updated. + `data_center` \n + The data center that is being updated. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6418,22 +6694,22 @@ def storage_domains_service(self): """ Attach and detach storage domains to and from a data center. For attaching a single storage domain we should use the following POST request: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/storagedomains - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml data1 - ---- + ``` For detaching a single storage domain we should use the following DELETE request: - [source] - ---- + + ``` DELETE /ovirt-engine/api/datacenters/123/storagedomains/123 - ---- + ``` """ return AttachedStorageDomainsService(self._connection, '%s/storagedomains' % self._path) @@ -6501,14 +6777,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6559,13 +6839,17 @@ def update( This method supports the following parameters: - `network`:: The data center network. + `network` \n + The data center network. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6611,28 +6895,32 @@ def add( """ Create a new network in a data center. Post a request like in the example below to create a new network in a data center with an ID of `123`. - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/networks - ---- + ``` Use the following example in its body: - [source,xml] - ---- + + ```xml mynetwork - ---- + ``` This method supports the following parameters: - `network`:: The network object to be created in the data center. + `network` \n + The network object to be created in the data center. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6661,16 +6949,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of networks to return. If not specified, all the networks are returned. + `max` \n + Sets the maximum number of networks to return. If not specified, all the networks are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6736,29 +7029,33 @@ def add( Creates a new data center. Creation of a new data center requires the `name` and `local` elements. For example, to create a data center named `mydc` that uses shared storage (NFS, iSCSI or fibre channel) send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml mydc false - ---- + ``` This method supports the following parameters: - `data_center`:: The data center that is being added. + `data_center` \n + The data center that is being added. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6786,13 +7083,13 @@ def list( """ Lists the data centers. The following request retrieves a representation of the data centers: - [source] - ---- + + ``` GET /ovirt-engine/api/datacenters - ---- + ``` The above request performed with `curl`: - [source,bash] - ---- + + ```bash curl \ --request GET \ --cacert /etc/pki/ovirt-engine/ca.pem \ @@ -6800,10 +7097,10 @@ def list( --header "Accept: application/xml" \ --user "admin@internal:mypassword" \ https://myengine.example.com/ovirt-engine/api/datacenters - ---- + ``` This is what an example response could look like: - [source,xml] - ---- + + ```xml Default The default Data Center @@ -6828,7 +7125,7 @@ def list( 0 - ---- + ``` Note the `id` code of your `Default` data center. This code identifies this data center in relation to other resources of your virtual environment. The data center also contains a link to the storage domains collection. The data center uses this collection to @@ -6839,24 +7136,32 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of data centers to return. If not specified all the data centers are returned. + `max` \n + Sets the maximum number of data centers to return. If not specified all the data centers are returned. - `search`:: A query string used to restrict the returned data centers. + `search` \n + A query string used to restrict the returned data centers. - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed taking case into + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6931,12 +7236,12 @@ def get( """ Returns the details of the attachment, including the bootable flag and link to the disk. An example of getting a disk attachment: - [source] - ---- + + ``` GET /ovirt-engine/api/vms/123/diskattachments/456 - ---- - [source,xml] - ---- + ``` + + ```xml true true @@ -6944,19 +7249,23 @@ def get( - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -6984,22 +7293,26 @@ def remove( This will only detach the disk from the virtual machine, but won't remove it from the system, unless the `detach_only` parameter is `false`. An example of removing a disk attachment: - [source] - ---- + + ``` DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true - ---- + ``` This method supports the following parameters: - `detach_only`:: Indicates if the disk should only be detached from the virtual machine, but not removed from the system. + `detach_only` \n + Indicates if the disk should only be detached from the virtual machine, but not removed from the system. The default value is `true`, which won't remove the disk from the system. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7025,8 +7338,8 @@ def update( ): """ Update the disk attachment and the disk properties within it. - [source] - ---- + + ``` PUT /vms/{vm:id}/disksattachments/{attachment:id} true @@ -7038,7 +7351,7 @@ def update( ... - ---- + ``` """ @@ -7068,9 +7381,7 @@ def __str__(self): class DiskAttachmentsService(Service): """ This service manages the set of disks attached to a virtual machine. Each attached disk is represented by a - xref:types-disk_attachment[DiskAttachment], containing the bootable flag, the disk interface and the reference to - the disk. - + `DiskAttachment`, containing the bootable flag, the disk interface and the reference to the disk. """ def __init__(self, connection, path): @@ -7088,8 +7399,8 @@ def add( """ Adds a new disk attachment to the virtual machine. The `attachment` parameter can contain just a reference, if the disk already exists: - [source,xml] - ---- + + ```xml true true @@ -7097,10 +7408,10 @@ def add( true - ---- + ``` Or it can contain the complete representation of the disk, if the disk doesn't exist yet: - [source,xml] - ---- + + ```xml true true @@ -7112,13 +7423,13 @@ def add( ... - ---- + ``` In this case the disk will be created and then attached to the virtual machine. In both cases, use the following URL for a virtual machine with an id `345`: - [source] - ---- + + ``` POST /ovirt-engine/api/vms/345/diskattachments - ---- + ``` IMPORTANT: The server accepts requests that do not contain the `active` attribute, but the effect is undefined. In some cases the disk will be automatically activated and in other cases it won't. To avoid issues it is strongly recommended to always include the `active` attribute with the desired @@ -7127,13 +7438,17 @@ def add( This method supports the following parameters: - `attachment`:: The disk attachment to add to the virtual machine. + `attachment` \n + The disk attachment to add to the virtual machine. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7161,14 +7476,18 @@ def list( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7194,13 +7513,17 @@ def add_providing_disk_id( """ This method supports the following parameters: - `attachment`:: The disk attachment to add to the virtual machine. + `attachment` \n + The disk attachment to add to the virtual machine. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7224,13 +7547,17 @@ def add_signature1( """ This method supports the following parameters: - `attachment`:: The disk attachment to add to the virtual machine. + `attachment` \n + The disk attachment to add to the virtual machine. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7287,14 +7614,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7320,13 +7651,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7448,16 +7783,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of profiles to return. If not specified all the profiles are returned. + `max` \n + Sets the maximum number of profiles to return. If not specified all the profiles are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7517,14 +7857,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7550,13 +7894,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7616,20 +7964,27 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of snapshots to return. If not specified all the snapshots are returned. + `max` \n + Sets the maximum number of snapshots to return. If not specified all the snapshots are returned. - `include_active`:: If true return also active snapshots. If not specified active snapshots are not returned. + `include_active` \n + If true return also active snapshots. If not specified active snapshots are not returned. - `include_template`:: If true return also template snapshots. If not specified template snapshots are not returned. + `include_template` \n + If true return also template snapshots. If not specified template snapshots are not returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7700,22 +8055,21 @@ def add( """ Adds a new floating disk. There are three types of disks that can be added - disk image, direct LUN and Managed Block disk. - link:https://wiki.openstack.org/wiki/Cinder[Cinder] integration has been replaced by Managed Block Storage. + link:https://wiki.openstack.org/wiki/Cinder integration has been replaced by Managed Block Storage. *Adding a new image disk:* - When creating a new floating image xref:types-disk[Disk], the API requires the `storage_domain`, `provisioned_size` + When creating a new floating image, the API requires the `storage_domain`, `provisioned_size` and `format` attributes. - Note that block storage domains (i.e. storage domains with the xref:types-storage_type[storage type] of iSCSI or - FCP) do not support the combination of the raw `format` with `sparse=true`, so `sparse=false` must be stated - explicitly. + Note that block storage domains (i.e. storage domains with the `StorageType` of iSCSI or FCP) + do not support the combination of the raw `format` with `sparse=true`, so `sparse=false` must be stated explicitly. To create a new floating image disk with specified `provisioned_size`, `format` and `name` on a storage domain with an id `123` and enabled for incremental backup, send a request as follows: - [source] - ---- + + ``` POST /ovirt-engine/api/disks - ---- + ``` With a request body as follows: - [source,xml] - ---- + + ```xml @@ -7725,7 +8079,7 @@ def add( cow incremental - ---- + ``` *Adding a new direct LUN disk:* When adding a new floating direct LUN via the API, there are two flavors that can be used: . With a `host` element - in this case, the host is used for sanity checks (e.g., that the LUN is visible) and @@ -7735,13 +8089,13 @@ def add( To create a new floating direct LUN disk with a `host` element with an id `123`, specified `alias`, `type` and `logical_unit` with an id `456` (that has the attributes `address`, `port` and `target`), send a request as follows: - [source] - ---- + + ``` POST /ovirt-engine/api/disks - ---- + ``` With a request body as follows: - [source,xml] - ---- + + ```xml mylun @@ -7756,11 +8110,10 @@ def add( - ---- + ``` To create a new floating direct LUN disk without using a host, remove the `host` element. *Adding a new Cinder disk:* Cinder integration has been replaced by Managed Block Storage. - //TODO: Add an example for adding an MBS disk *Adding a floating disks in order to upload disk snapshots:* Since version 4.2 of the engine it is possible to upload disks with snapshots. This request should be used to create the base image of the @@ -7771,8 +8124,7 @@ def add( backup process. The image identifier can be also fetched using the `qemu-img info` command. For example, if the disk image is stored into a file named `b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img`: - [source,shell] - ---- + ```shell $ qemu-img info b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img image: b548366b-fb51-4b41-97be-733c887fe305 file format: qcow2 @@ -7781,16 +8133,16 @@ def add( cluster_size: 65536 backing file: ad58716a-1fe9-481f-815e-664de1df04eb backing file format: raw - ---- + ``` To create a disk with with the disk identifier and image identifier obtained with the `qemu-img info` command shown above, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/disks - ---- + ``` With a request body as follows: - [source,xml] - ---- + ] + ```xml b548366b-fb51-4b41-97be-733c887fe305 @@ -7800,18 +8152,22 @@ def add( 1048576 cow - ---- + ``` This method supports the following parameters: - `disk`:: The disk. + `disk` \n + The disk. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7837,13 +8193,13 @@ def list( ): """ Get list of disks. - [source] - ---- + + ``` GET /ovirt-engine/api/disks - ---- + ``` You will get a XML response which will look like this one: - [source,xml] - ---- + + ```xml ... @@ -7863,29 +8219,35 @@ def list( ... - ---- + ``` The order of the returned list of disks is guaranteed only if the `sortby` clause is included in the `search` parameter. - This method supports the following parameters: - `max`:: Sets the maximum number of disks to return. If not specified all the disks are returned. + `max` \n + Sets the maximum number of disks to return. If not specified all the disks are returned. - `search`:: A query string used to restrict the returned disks. + `search` \n + A query string used to restrict the returned disks. - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed taking case into + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7925,13 +8287,17 @@ def add_lun( This method supports the following parameters: - `disk`:: The disk. + `disk` \n + The disk. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -7958,13 +8324,17 @@ def add_on_storage_domain( This method supports the following parameters: - `disk`:: The disk. + `disk` \n + The disk. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8024,12 +8394,12 @@ def get( """ Gets the authentication domain information. Usage: - .... + ``` GET /ovirt-engine/api/domains/5678 - .... + ``` Will return the domain information: - [source,xml] - ---- + + ```xml internal-authz @@ -8037,19 +8407,23 @@ def get( - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8116,14 +8490,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8176,22 +8554,29 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of groups to return. If not specified all the groups are returned. + `max` \n + Sets the maximum number of groups to return. If not specified all the groups are returned. - `search`:: A query string used to restrict the returned groups. + `search` \n + A query string used to restrict the returned groups. - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed taking case into + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8260,12 +8645,12 @@ def get( """ Gets the domain user information. Usage: - .... + ``` GET /ovirt-engine/api/domains/5678/users/1234 - .... + ``` Will return the domain user information: - [source,xml] - ---- + ] + ```xml admin * @@ -8276,19 +8661,23 @@ def get( - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8338,14 +8727,18 @@ def list( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8396,12 +8789,12 @@ def list( """ List all the users in the domain. Usage: - .... + ``` GET /ovirt-engine/api/domains/5678/users - .... + ``` Will return the list of users in the domain: - [source,xml] - ---- + ] + ```xml admin @@ -8414,28 +8807,35 @@ def list( - ---- + ``` The order of the returned list of users isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of users to return. If not specified all the users are returned. + `max` \n + Sets the maximum number of users to return. If not specified all the users are returned. - `search`:: A query string used to restrict the returned users. + `search` \n + A query string used to restrict the returned users. - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed taking case into + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8508,12 +8908,12 @@ def list( """ List all the authentication domains in the system. Usage: - .... + ``` GET /ovirt-engine/api/domains - .... + ``` Will return the list of domains: - [source,xml] - ---- + + ```xml internal-authz @@ -8523,22 +8923,27 @@ def list( - ---- + ``` The order of the returned list of domains isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of domains to return. If not specified all the domains are returned. + `max` \n + Sets the maximum number of domains to return. If not specified all the domains are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8602,12 +9007,12 @@ def get( """ Get an event. An example of getting an event: - [source] - ---- + + ``` GET /ovirt-engine/api/events/123 - ---- - [source,xml] - ---- + ``` + + ```xml Host example.com was added by admin@internal-authz. 42 @@ -8621,7 +9026,7 @@ def get( - ---- + ``` Note that the number of fields changes according to the information that resides on the event. For example, for storage domain related events you will get the storage domain reference, as well as the reference for the data center this storage domain resides in. @@ -8629,14 +9034,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8662,21 +9071,25 @@ def remove( """ Removes an event from internal audit log. An event can be removed by sending following request - [source] - ---- + + ``` DELETE /ovirt-engine/api/events/123 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8728,18 +9141,18 @@ def get( Gets the information about the event-subscription. For example to retrieve the information about the subscription of user '123' to the event 'vm_console_detected': - .... + ``` GET /ovirt-engine/api/users/123/vm_console_detected - .... - [source,xml] - ---- + ``` + + ```xml vm_console_detected smtp
a@b.com
 - ---- + ``` """ @@ -8764,20 +9177,23 @@ def remove( """ Removes the event-subscription from the system. For example to remove user 123's subscription to `vm_console_detected` event: - .... + ``` DELETE /ovirt-engine/api/users/123/vm_console_detected - .... - + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8832,17 +9248,17 @@ def add( An event-subscription is always added in the context of a user. For example, to add new event-subscription for `host_high_cpu_use` for user `123`, and have the notification sent to the e-mail address: `a@b.com`, send a request like this: - .... + ``` POST /ovirt-engine/api/users/123/eventsubscriptions - .... + ``` With a request body like this: - [source,xml] - ---- + + ```xml host_high_cpu_use
a@b.com
 - ---- + ``` The event name will become the ID of the new event-subscription entity: GET .../api/users/123/eventsubscriptions/host_high_cpu_use Note that no user id is provided in the request body. This is because the user-id (in this case 123) @@ -8853,13 +9269,17 @@ def add( This method supports the following parameters: - `event_subscription`:: The added event-subscription. + `event_subscription` \n + The added event-subscription. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8884,11 +9304,11 @@ def list( """ List the event-subscriptions for the provided user. For example to list event-subscriptions for user `123`: - .... + ``` GET /ovirt-engine/api/users/123/event-subscriptions - .... - [source,xml] - ---- + ``` + + ```xml host_install_failed @@ -8903,22 +9323,27 @@ def list(
a@b.com
 - ---- + ``` This method supports the following parameters: - `max`:: Sets the maximum number of event-subscriptions to return. + `max` \n + Sets the maximum number of event-subscriptions to return. If not specified all the event-subscriptions are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -8986,8 +9411,8 @@ def add( administrator of the system. For example, an external monitoring tool may be able to detect that a file system is full inside the guest operating system of a virtual machine. This event can be added to the internal audit log sending a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/events File system /home is full @@ -8995,11 +9420,11 @@ def add( mymonitor 1467879754 - ---- + ``` Events can also be linked to specific objects. For example, the above event could be linked to the specific virtual machine where it happened, using the `vm` link: - [source] - ---- + + ``` POST /ovirt-engine/api/events File system /home is full @@ -9008,7 +9433,7 @@ def add( 1467879754 - ---- + ``` NOTE: When using links, like the `vm` in the previous example, only the `id` attribute is accepted. The `name` attribute, if provided, is simply ignored. @@ -9039,13 +9464,13 @@ def list( ): """ Get list of events. - [source] - ---- + + ``` GET /ovirt-engine/api/events - ---- + ``` To the above request we get following response: - [source,xml] - ---- + + ```xml User admin@internal-authz logged out. @@ -9070,7 +9495,7 @@ def list( - ---- + ``` The following events occur: * id="1" - The API logs in the admin user account. * id="2" - The API logs out of the admin user account. @@ -9078,35 +9503,38 @@ def list( `search` parameter, then the events will be ordered according to that clause. If the `sortby` clause isn't included, then the events will be sorted by the numeric value of the `id` attribute, starting with the highest value. This, combined with the `max` parameter, simplifies obtaining the most recent event: - .... + ``` GET /ovirt-engine/api/events?max=1 - .... + ``` This method supports the following parameters: - `from_`:: Indicates the event index after which events should be returned. The indexes of events are + `from_` \n + Indicates the event index after which events should be returned. The indexes of events are strictly increasing, so when this parameter is used only the events with greater indexes will be returned. For example, the following request will return only the events with indexes greater than `123`: - [source] - ---- + + ``` GET /ovirt-engine/api/events?from=123 - ---- + ``` This parameter is optional, and if not specified then the first event returned will be most recently generated. - `max`:: Sets the maximum number of events to return. If not specified all the events are returned. + `max` \n + Sets the maximum number of events to return. If not specified all the events are returned. - `search`:: The events service provides search queries similar to other resource services. + `search` \n + The events service provides search queries similar to other resource services. We can search by providing specific severity. - [source] - ---- + + ``` GET /ovirt-engine/api/events?search=severity%3Dnormal - ---- + ``` To the above request we get a list of events which severity is equal to `normal`: - [source,xml] - ---- + + ```xml User admin@internal-authz logged out. @@ -9129,40 +9557,45 @@ def list( - ---- + ``` A virtualization environment generates a large amount of events after a period of time. However, the API only displays a default number of events for one search query. To display more than the default, the API separates results into pages with the page command in a search query. The following search query tells the API to paginate results using a page value in combination with the sortby clause: - [source] - ---- + + ``` sortby time asc page 1 - ---- + ``` Below example paginates event resources. The URL-encoded request is: - [source] - ---- + + ``` GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201 - ---- + ``` Increase the page value to view the next page of results. - [source] - ---- + + ``` GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202 - ---- + ``` - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed taking case into + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9203,13 +9636,17 @@ def undelete( """ This method supports the following parameters: - `async_`:: Indicates if the un-delete should be performed asynchronously. + `async_` \n + Indicates if the un-delete should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9276,12 +9713,12 @@ def get( """ Retrieves external compute resource details. For example, to get the details of compute resource `234` of provider `123`, send a request like this: - .... + ``` GET /ovirt-engine/api/externalhostproviders/123/computeresources/234 - .... + ``` It will return a response like this: - [source,xml] - ---- + + ```xml hostname oVirt @@ -9289,19 +9726,23 @@ def get( admin@internal - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9353,12 +9794,12 @@ def list( """ Retrieves a list of external compute resources. For example, to retrieve the compute resources of external host provider `123`, send a request like this: - .... + ``` GET /ovirt-engine/api/externalhostproviders/123/computeresources - .... + ``` It will return a response like this: - [source,xml] - ---- + + ```xml hostname @@ -9369,22 +9810,27 @@ def list( ... - ---- + ``` The order of the returned list of compute resources isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of resources to return. If not specified all the resources are returned. + `max` \n + Sets the maximum number of resources to return. If not specified all the resources are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9450,12 +9896,12 @@ def get( Retrieves information about an host that is managed in external provider management system, such as Foreman. The information includes hostname, address, subnet, base image and more. For example, to get the details of host `234` from provider `123`, send a request like this: - .... + ``` GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234 - .... + ``` The result will be like this: - [source,xml] - ---- + + ```xml mac001a4ad04040 10.34.67.43 @@ -9464,19 +9910,23 @@ def get( sat0 - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9526,12 +9976,12 @@ def list( Get list of discovered hosts' information. Discovered hosts are fetched from third-party providers such as Foreman. To list all discovered hosts for provider `123` send the following: - [source] - ---- + + ``` GET /ovirt-engine/api/externalhostproviders/123/discoveredhost - ---- - [source,xml] - ---- + ``` + + ```xml mac001a4ad04031 @@ -9551,22 +10001,27 @@ def list( ... - ---- + ``` The order of the returned list of hosts isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of hosts to return. If not specified all the hosts are returned. + `max` \n + Sets the maximum number of hosts to return. If not specified all the hosts are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9626,14 +10081,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9682,12 +10141,12 @@ def get( """ Get host group information. For example, to get the details of hostgroup `234` of provider `123`, send a request like this: - .... + ``` GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234 - .... + ``` It will return a response like this: - [source,xml] - ---- + + ```xml rhel7 x86_64 @@ -9696,19 +10155,23 @@ def get( sat0 - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9759,12 +10222,12 @@ def list( Host group is a term of host providers - the host group includes provision details. This API returns all possible hostgroups exposed by the external provider. For example, to get the details of all host groups of provider `123`, send a request like this: - .... + ``` GET /ovirt-engine/api/externalhostproviders/123/hostgroups - .... + ``` The response will be like this: - [source,xml] - ---- + + ```xml rhel7 @@ -9776,22 +10239,27 @@ def list( ... - ---- + ``` The order of the returned list of host groups isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of groups to return. If not specified all the groups are returned. + `max` \n + Sets the maximum number of groups to return. If not specified all the groups are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9884,18 +10352,24 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of providers to return. If not specified all the providers are returned. + `max` \n + Sets the maximum number of providers to return. If not specified all the providers are returned. - `search`:: A query string used to restrict the returned external host providers. + `search` \n + A query string used to restrict the returned external host providers. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -9964,16 +10438,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of hosts to return. If not specified all the hosts are returned. + `max` \n + Sets the maximum number of hosts to return. If not specified all the hosts are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -10038,14 +10517,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -10097,14 +10580,18 @@ def list( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -10189,21 +10676,25 @@ def test_connectivity( """ In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. - [source] - ---- + + ``` POST /ovirt-engine/api/externalhostproviders/123/testconnectivity - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the test should be performed asynchronously. + `async_` \n + Indicates if the test should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -10264,31 +10755,35 @@ def get( ): """ Get specific certificate. - [source] - ---- + + ``` GET /ovirt-engine/api/externalhostproviders/123/certificate/0 - ---- + ``` And here is sample response: - [source,xml] - ---- + + ```xml provider.example.com CN=provider.example.com ... - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -10336,34 +10831,39 @@ def list( ): """ Returns the chain of certificates presented by the external provider. - [source] - ---- + + ``` GET /ovirt-engine/api/externalhostproviders/123/certificates - ---- + ``` And here is sample response: - [source,xml] - ---- + + ```xml ... ... - ---- + ``` The order of the returned certificates is always guaranteed to be the sign order: the first is the certificate of the server itself, the second the certificate of the CA that signs the first, so on. This method supports the following parameters: - `max`:: Sets the maximum number of certificates to return. If not specified all the certificates are returned. + `max` \n + Sets the maximum number of certificates to return. If not specified all the certificates are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -10429,13 +10929,13 @@ def add( """ This operation is used to import a template from external hypervisor. For example import of a template OVA can be facilitated using the following request: - [source] - ---- + + ``` POST /externaltemplateimports - ---- - With request body of type xref:types-external_template_import[ExternalTemplateImport], for example: - [source,xml] - ---- + ``` + With request body of type `ExternalTemplateImport`, for example: + + ```xml - ---- + ``` Creating an instance type with all hardware configurations with a request body like this: - [source,xml] - ---- + + ```xml myinstancetype @@ -15295,7 +16079,7 @@ def add( true - ---- + ``` """ @@ -15328,23 +16112,30 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of instance types to return. If not specified all the instance + `max` \n + Sets the maximum number of instance types to return. If not specified all the instance types are returned. - `search`:: A query string used to restrict the returned templates. + `search` \n + A query string used to restrict the returned templates. - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15413,14 +16204,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15446,21 +16241,25 @@ def remove( """ Removes of an existing iSCSI bond. For example, to remove the iSCSI bond `456` send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15493,29 +16292,33 @@ def update( Updates an iSCSI bond. Updating of an iSCSI bond can be done on the `name` and the `description` attributes only. For example, to update the iSCSI bond `456` of data center `123`, send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234 - ---- + ``` The request body should look like this: - [source,xml] - ---- + + ```xml mybond My iSCSI bond - ---- + ``` This method supports the following parameters: - `bond`:: The iSCSI bond to update. + `bond` \n + The iSCSI bond to update. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15586,13 +16389,13 @@ def add( Create a new iSCSI bond on a data center. For example, to create a new iSCSI bond on data center `123` using storage connections `456` and `789`, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/iscsibonds - ---- + ``` The request body should look like this: - [source,xml] - ---- + + ```xml mybond @@ -15603,7 +16406,7 @@ def add( - ---- + ``` """ @@ -15634,16 +16437,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of bonds to return. If not specified all the bonds are returned. + `max` \n + Sets the maximum number of bonds to return. If not specified all the bonds are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15706,26 +16514,30 @@ def clear( """ Set an external job execution to be cleared by the system. For example, to set a job with identifier `123` send the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/jobs/clear - ---- + ``` With the following request body: - [source,xml] - ---- + + ```xml - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15757,34 +16569,40 @@ def end( """ Marks an external job execution as ended. For example, to terminate a job with identifier `123` send the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/jobs/end - ---- + ``` With the following request body: - [source,xml] - ---- + + ```xml true finished - ---- + ``` This method supports the following parameters: - `force`:: Indicates if the job should be forcibly terminated. + `force` \n + Indicates if the job should be forcibly terminated. - `succeeded`:: Indicates if the job should be marked as successfully finished or as failed. + `succeeded` \n + Indicates if the job should be marked as successfully finished or as failed. This parameter is optional, and the default value is `true`. - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15817,13 +16635,13 @@ def get( ): """ Retrieves a job. - [source] - ---- + + ``` GET /ovirt-engine/api/jobs/123 - ---- + ``` You will receive response in XML like this one: - [source,xml] - ---- + + ```xml @@ -15839,19 +16657,23 @@ def get( failed - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15911,21 +16733,21 @@ def add( """ Add an external job. For example, to add a job with the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/jobs - ---- + ``` With the following request body: - [source,xml] - ---- + + ```xml Doing some work true - ---- + ``` The response should look like: - [source,xml] - ---- + + ```xml @@ -15940,18 +16762,22 @@ def add( started - ---- + ``` This method supports the following parameters: - `job`:: Job that will be added. + `job` \n + Job that will be added. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -15977,13 +16803,13 @@ def list( ): """ Retrieves the representation of the jobs. - [source] - ---- + + ``` GET /ovirt-engine/api/jobs - ---- + ``` You will receive response in XML like this one: - [source,xml] - ---- + + ```xml @@ -16002,28 +16828,35 @@ def list( ... - ---- + ``` The order of the returned list of jobs isn't guaranteed. This method supports the following parameters: - `search`:: A query string used to restrict the returned jobs. + `search` \n + A query string used to restrict the returned jobs. - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed taking case into + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `max`:: Sets the maximum number of jobs to return. If not specified all the jobs are returned. + `max` \n + Sets the maximum number of jobs to return. If not specified all the jobs are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16096,13 +16929,13 @@ def list( ): """ Retrieves the representation of the Katello errata. - [source] - ---- + + ``` GET /ovirt-engine/api/katelloerrata - ---- + ``` You will receive response in XML like this one: - [source,xml] - ---- + + ```xml RHBA-2013:XYZ @@ -16121,22 +16954,27 @@ def list( ... - ---- + ``` The order of the returned list of erratum isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of errata to return. If not specified all the errata are returned. + `max` \n + Sets the maximum number of errata to return. If not specified all the errata are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16200,13 +17038,13 @@ def get( ): """ Retrieves a Katello erratum. - [source] - ---- + + ``` GET /ovirt-engine/api/katelloerrata/123 - ---- + ``` You will receive response in XML like this one: - [source,xml] - ---- + + ```xml RHBA-2013:XYZ The description of the erratum @@ -16222,19 +17060,23 @@ def get( ... - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16284,14 +17126,18 @@ def list( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16337,14 +17183,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16370,21 +17220,25 @@ def remove( """ Removes a MAC address pool. For example, to remove the MAC address pool having id `123` send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/macpools/123 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16417,13 +17271,13 @@ def update( Updates a MAC address pool. The `name`, `description`, `allow_duplicates`, and `ranges` attributes can be updated. For example, to update the MAC address pool of id `123` send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/macpools/123 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml UpdatedMACPool An updated MAC address pool @@ -16439,7 +17293,7 @@ def update( - ---- + ``` """ @@ -16505,13 +17359,13 @@ def add( Creates a new MAC address pool. Creation of a MAC address pool requires values for the `name` and `ranges` attributes. For example, to create MAC address pool send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/macpools - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml MACPool A MAC address pool @@ -16524,7 +17378,7 @@ def add( - ---- + ``` """ @@ -16555,16 +17409,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of pools to return. If not specified all the pools are returned. + `max` \n + Sets the maximum number of pools to return. If not specified all the pools are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16653,13 +17512,17 @@ def move( """ This method supports the following parameters: - `async_`:: Indicates if the move should be performed asynchronously. + `async_` \n + Indicates if the move should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16713,13 +17576,13 @@ def get( """ Gets a logical network. For example: - [source] - ---- + + ``` GET /ovirt-engine/api/networks/123 - ---- + ``` Will respond: - [source,xml] - ---- + + ```xml ovirtmgmt Default Management Network @@ -16733,19 +17596,23 @@ def get( - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16771,34 +17638,38 @@ def remove( """ Removes a logical network, or the association of a logical network to a data center. For example, to remove the logical network `123` send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/networks/123 - ---- + ``` Each network is bound exactly to one data center. So if we disassociate network with data center it has the same result as if we would just remove that network. However it might be more specific to say we're removing network `456` of data center `123`. For example, to remove the association of network `456` to data center `123` send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/datacenters/123/networks/456 - ---- + ``` NOTE: To remove an external logical network, the network has to be removed directly from its provider by - link:https://developer.openstack.org/api-ref/network[OpenStack Networking API]. + link:https://developer.openstack.org/api-ref/network. The entity representing the external network inside {product-name} is removed automatically, - if xref:types-open_stack_network_provider-attributes-auto_sync[`auto_sync`] is enabled for the provider, + if `ovirtsdk4.types.OpenStackNetworkProvider.auto_sync` is enabled for the provider, otherwise the entity has to be removed using this method. This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16831,31 +17702,31 @@ def update( Updates a logical network. The `name`, `description`, `ip`, `vlan`, `stp` and `display` attributes can be updated. For example, to update the description of the logical network `123` send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/networks/123 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml My updated description - ---- + ``` The maximum transmission unit of a network is set using a PUT request to specify the integer value of the `mtu` attribute. For example, to set the maximum transmission unit send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/datacenters/123/networks/456 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml 1500 - ---- + ``` NOTE: Updating external networks is not propagated to the provider. @@ -16942,14 +17813,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -16975,13 +17850,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17096,16 +17975,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of attachments to return. If not specified all the attachments are returned. + `max` \n + Sets the maximum number of attachments to return. If not specified all the attachments are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17150,8 +18034,8 @@ def __str__(self): class NetworkFilterService(Service): """ Manages a network filter. - [source,xml] - ---- + + ```xml example-network-filter-b @@ -17161,7 +18045,7 @@ class NetworkFilterService(Service): -1 - ---- + ``` Please note that version is referring to the minimal support version for the specific filter. """ @@ -17183,14 +18067,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17221,7 +18109,7 @@ class NetworkFiltersService(Service): """ Represents a readonly network filters sub-collection. The network filter enables to filter packets send to/from the VM's nic according to defined rules. - For more information please refer to xref:services-network_filter[NetworkFilter] service documentation + For more information please refer to `NetworkFilterService` service documentation Network filters are supported in different versions, starting from version 3.0. A network filter is defined for each vnic profile. A vnic profile is defined for a specific network. @@ -17233,13 +18121,13 @@ class NetworkFiltersService(Service): Please note, that if a network is assigned to cluster with a version supporting a network filter, the filter may not be available due to the data center version being smaller then the network filter's version. Example of listing all of the supported network filters for a specific cluster: - [source] - ---- + + ``` GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters - ---- + ``` Output: - [source,xml] - ---- + + ```xml example-network-filter-a @@ -17269,7 +18157,7 @@ class NetworkFiltersService(Service): - ---- + ``` """ @@ -17292,14 +18180,18 @@ def list( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17355,14 +18247,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17388,21 +18284,25 @@ def remove( """ Removes a label from a logical network. For example, to remove the label `exemplary` from a logical network having id `123` send the following request: - [source] - ---- + + ``` DELETE /ovirt-engine/api/networks/123/networklabels/exemplary - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17457,15 +18357,15 @@ def add( You can attach labels to a logical network to automate the association of that logical network with physical host network interfaces to which the same label has been attached. For example, to attach the label `mylabel` to a logical network having id `123` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/networks/123/networklabels - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml - ---- + ``` """ @@ -17496,16 +18396,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of labels to return. If not specified all the labels are returned. + `max` \n + Sets the maximum number of labels to return. If not specified all the labels are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17572,44 +18477,44 @@ def add( Creates a new logical network, or associates an existing network with a data center. Creation of a new network requires the `name` and `data_center` elements. For example, to create a network named `mynetwork` for data center `123` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/networks - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml mynetwork - ---- + ``` To associate the existing network `456` with the data center `123` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/networks - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml ovirtmgmt - ---- + ``` To create a network named `exnetwork` on top of an external _OpenStack_ network provider `456` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/networks - ---- - [source,xml] - ---- + ``` + + ```xml exnetwork - ---- + ``` """ @@ -17638,13 +18543,13 @@ def list( """ List logical networks. For example: - [source] - ---- + + ``` GET /ovirt-engine/api/networks - ---- + ``` Will respond: - [source,xml] - ---- + + ```xml ovirtmgmt @@ -17661,29 +18566,36 @@ def list( ... - ---- + ``` The order of the returned list of networks is guaranteed only if the `sortby` clause is included in the `search` parameter. This method supports the following parameters: - `max`:: Sets the maximum number of networks to return. If not specified all the networks are returned. + `max` \n + Sets the maximum number of networks to return. If not specified all the networks are returned. - `search`:: A query string used to restrict the returned networks. + `search` \n + A query string used to restrict the returned networks. - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed taking case into + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17757,14 +18669,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17790,10 +18706,10 @@ def remove( Removes the filter parameter. For example, to remove the filter parameter with id `123` on NIC `456` of virtual machine `789` send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123 - ---- + ``` """ @@ -17819,29 +18735,33 @@ def update( Updates the network filter parameter. For example, to update the network filter parameter having with with id `123` on NIC `456` of virtual machine `789` send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml updatedName updatedValue - ---- + ``` This method supports the following parameters: - `parameter`:: The network filter parameter that is being updated. + `parameter` \n + The network filter parameter that is being updated. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17888,29 +18808,33 @@ def add( Add a network filter parameter. For example, to add the parameter for the network filter on NIC `456` of virtual machine `789` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/vms/789/nics/456/networkfilterparameters - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml IP 10.0.1.2 - ---- + ``` This method supports the following parameters: - `parameter`:: The network filter parameter that is being added. + `parameter` \n + The network filter parameter that is being added. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -17938,14 +18862,18 @@ def list( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18003,14 +18931,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18042,13 +18974,13 @@ def import_( Imports a virtual machine from a Glance image storage domain. For example, to import the image with identifier `456` from the storage domain with identifier `123` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/openstackimageproviders/123/images/456/import - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml images0 @@ -18057,23 +18989,29 @@ def import_( images0 - ---- + ``` This method supports the following parameters: - `import_as_template`:: Indicates whether the image should be imported as a template. + `import_as_template` \n + Indicates whether the image should be imported as a template. - `cluster`:: This parameter is mandatory in case of using `import_as_template` and indicates which cluster should be used + `cluster` \n + This parameter is mandatory in case of using `import_as_template` and indicates which cluster should be used for import glance image as template. - `async_`:: Indicates if the import should be performed asynchronously. + `async_` \n + Indicates if the import should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18134,14 +19072,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18193,13 +19135,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18230,21 +19176,25 @@ def test_connectivity( """ In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. - [source] - ---- + + ``` POST /ovirt-engine/api/externalhostproviders/123/testconnectivity - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the test should be performed asynchronously. + `async_` \n + Indicates if the test should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18377,18 +19327,24 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of providers to return. If not specified all the providers are returned. + `max` \n + Sets the maximum number of providers to return. If not specified all the providers are returned. - `search`:: A query string used to restrict the returned OpenStack image providers. + `search` \n + A query string used to restrict the returned OpenStack image providers. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18457,16 +19413,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of images to return. If not specified all the images are returned. + `max` \n + Sets the maximum number of images to return. If not specified all the images are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18529,14 +19490,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18567,22 +19532,27 @@ def import_( This method supports the following parameters: - `data_center`:: The data center into which the network is to be imported. + `data_center` \n + The data center into which the network is to be imported. Data center is mandatory, and can be specified using the `id` or `name` attributes. The rest of the attributes will be ignored. - NOTE: If xref:types-open_stack_network_provider-attributes-auto_sync[`auto_sync`] is + NOTE: If `ovirtsdk4.types.OpenStackNetworkProvider.auto_sync` is enabled for the provider, the network might be imported automatically. To prevent this, automatic import can be disabled by setting the `auto_sync` to false, and enabling it again after importing the network. - `async_`:: Indicates if the import should be performed asynchronously. + `async_` \n + Indicates if the import should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18646,22 +19616,26 @@ def get( """ Returns the representation of the object managed by this service. For example, to get the OpenStack network provider with identifier `1234`, send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/openstacknetworkproviders/1234 - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18713,21 +19687,25 @@ def remove( """ Removes the provider. For example, to remove the OpenStack network provider with identifier `1234`, send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/openstacknetworkproviders/1234 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18758,21 +19736,25 @@ def test_connectivity( """ In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. - [source] - ---- + + ``` POST /ovirt-engine/api/externalhostproviders/123/testconnectivity - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the test should be performed asynchronously. + `async_` \n + Indicates if the test should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18804,13 +19786,13 @@ def update( Updates the provider. For example, to update `provider_name`, `requires_authentication`, `url`, `tenant_name` and `type` properties, for the OpenStack network provider with identifier `1234`, send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/openstacknetworkproviders/1234 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml ovn-network-provider false @@ -18818,18 +19800,22 @@ def update( oVirt external - ---- + ``` This method supports the following parameters: - `provider`:: The provider to update. + `provider` \n + The provider to update. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -18936,18 +19922,24 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of providers to return. If not specified all the providers are returned. + `max` \n + Sets the maximum number of providers to return. If not specified all the providers are returned. - `search`:: A query string used to restrict the returned OpenStack network providers. + `search` \n + A query string used to restrict the returned OpenStack network providers. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19018,16 +20010,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of networks to return. If not specified all the networks are returned. + `max` \n + Sets the maximum number of networks to return. If not specified all the networks are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19087,14 +20084,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19120,13 +20121,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19203,16 +20208,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of sub-networks to return. If not specified all the sub-networks are returned. + `max` \n + Sets the maximum number of sub-networks to return. If not specified all the sub-networks are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19274,14 +20284,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19307,13 +20321,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19419,16 +20437,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of keys to return. If not specified all the keys are returned. + `max` \n + Sets the maximum number of keys to return. If not specified all the keys are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19493,14 +20516,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19553,17 +20580,22 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `force`:: Indicates if the operation should succeed, and the provider removed from the database, + `force` \n + Indicates if the operation should succeed, and the provider removed from the database, even if something fails during the operation. This parameter is optional, and the default value is `false`. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19598,21 +20630,25 @@ def test_connectivity( """ In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. - [source] - ---- + + ``` POST /ovirt-engine/api/externalhostproviders/123/testconnectivity - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the test should be performed asynchronously. + `async_` \n + Indicates if the test should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19726,13 +20762,13 @@ def add( """ Adds a new volume provider. For example: - [source] - ---- + + ``` POST /ovirt-engine/api/openstackvolumeproviders - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml mycinder https://mycinder.example.com:8776 @@ -19744,7 +20780,7 @@ def add( mypassword mytenant - ---- + ``` """ @@ -19776,18 +20812,24 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of providers to return. If not specified all the providers are returned. + `max` \n + Sets the maximum number of providers to return. If not specified all the providers are returned. - `search`:: A query string used to restrict the returned volume providers. + `search` \n + A query string used to restrict the returned volume providers. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19852,14 +20894,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19912,16 +20958,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of volume types to return. If not specified all the volume types are returned. + `max` \n + Sets the maximum number of volume types to return. If not specified all the volume types are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -19981,14 +21032,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20041,16 +21096,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of networks to return. If not specified all the networks are returned. + `max` \n + Sets the maximum number of networks to return. If not specified all the networks are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20110,14 +21170,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20143,13 +21207,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20202,29 +21270,33 @@ def get( Gets the information about the permit of the role. For example to retrieve the information about the permit with the id `456` of the role with the id `123` send a request like this: - .... + ``` GET /ovirt-engine/api/roles/123/permits/456 - .... - [source,xml] - ---- + ``` + + ```xml change_vm_cd false - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20250,20 +21322,24 @@ def remove( """ Removes the permit from the role. For example to remove the permit with id `456` from the role with id `123` send a request like this: - .... + ``` DELETE /ovirt-engine/api/roles/123/permits/456 - .... + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20314,29 +21390,33 @@ def add( **kwargs ): """ - Adds a permit to the role. The permit name can be retrieved from the xref:services-cluster_levels[cluster_levels] service. + Adds a permit to the role. The permit name can be retrieved from the `ClusterLevelsService` service. For example to assign a permit `create_vm` to the role with id `123` send a request like this: - .... + ``` POST /ovirt-engine/api/roles/123/permits - .... + ``` With a request body like this: - [source,xml] - ---- + + ```xml create_vm - ---- + ``` This method supports the following parameters: - `permit`:: The permit to add. + `permit` \n + The permit to add. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20361,11 +21441,11 @@ def list( """ List the permits of the role. For example to list the permits of the role with the id `123` send a request like this: - .... + ``` GET /ovirt-engine/api/roles/123/permits - .... - [source,xml] - ---- + ``` + + ```xml change_vm_cd @@ -20378,22 +21458,27 @@ def list( - ---- + ``` The order of the returned list of permits isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of permits to return. If not specified all the permits are returned. + `max` \n + Sets the maximum number of permits to return. If not specified all the permits are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20454,13 +21539,13 @@ def get( ): """ Get specified QoS in the data center. - [source] - ---- + + ``` GET /ovirt-engine/api/datacenters/123/qoss/123 - ---- + ``` You will get response like this one below: - [source,xml] - ---- + + ```xml 123 123 @@ -20469,19 +21554,23 @@ def get( storage - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20506,21 +21595,25 @@ def remove( ): """ Remove specified QoS from datacenter. - [source] - ---- + + ``` DELETE /ovirt-engine/api/datacenters/123/qoss/123 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20551,20 +21644,20 @@ def update( ): """ Update the specified QoS in the dataCenter. - [source] - ---- + + ``` PUT /ovirt-engine/api/datacenters/123/qoss/123 - ---- + ``` For example with curl: - [source] - ---- + + ``` curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \ "32132110" \ https://engine/ovirt-engine/api/datacenters/123/qoss/123 - ---- + ``` You will receive response like this: - [source,xml] - ---- + + ```xml 321 321 @@ -20573,18 +21666,22 @@ def update( storage - ---- + ``` This method supports the following parameters: - `qos`:: Updated QoS object. + `qos` \n + Updated QoS object. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20637,13 +21734,13 @@ def add( ): """ Add a new QoS to the dataCenter. - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/qoss - ---- + ``` The response will look as follows: - [source,xml] - ---- + + ```xml 123 123 @@ -20651,18 +21748,22 @@ def add( storage - ---- + ``` This method supports the following parameters: - `qos`:: Added QoS object. + `qos` \n + Added QoS object. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20686,34 +21787,39 @@ def list( ): """ Returns the list of _quality of service_ configurations available in the data center. - [source] - ---- + + ``` GET /ovirt-engine/api/datacenter/123/qoss - ---- + ``` You will get response which will look like this: - [source, xml] - ---- + + ```xml ... ... ... - ---- + ``` The returned list of quality of service configurations isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of QoS descriptors to return. If not specified all the descriptors are returned. + `max` \n + Sets the maximum number of QoS descriptors to return. If not specified all the descriptors are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20778,12 +21884,12 @@ def get( """ Retrieves a quota. An example of retrieving a quota: - [source] - ---- + + ``` GET /ovirt-engine/api/datacenters/123/quotas/456 - ---- - [source,xml] - ---- + ``` + + ```xml myquota My new quota for virtual machines @@ -20792,19 +21898,23 @@ def get( 20 80 - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20830,24 +21940,28 @@ def remove( """ Delete a quota. An example of deleting a quota: - [source] - ---- + + ``` DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321 -0472718ab224 HTTP/1.1 Accept: application/xml Content-type: application/xml - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -20879,21 +21993,19 @@ def update( """ Updates a quota. An example of updating a quota: - [source] - ---- + + ``` PUT /ovirt-engine/api/datacenters/123/quotas/456 - ---- - [source,xml] - ---- + ``` + + ```xml 30 70 20 80 - ---- - - + ``` """ # Check the types of the parameters: Service._check_types([ @@ -20971,14 +22083,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21004,13 +22120,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21092,16 +22212,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of limits to return. If not specified all the limits are returned. + `max` \n + Sets the maximum number of limits to return. If not specified all the limits are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21161,14 +22286,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21194,13 +22323,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the update should be performed asynchronously. + `async_` \n + Indicates if the update should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21253,30 +22386,30 @@ def add( """ Adds a storage limit to a specified quota. To create a 100GiB storage limit for all storage domains in a data center, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml 100 - ---- + ``` To create a 50GiB storage limit for a storage domain with the ID `000`, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml 50 - ---- + ``` """ @@ -21307,16 +22440,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of limits to return. If not specified, all the limits are returned. + `max` \n + Sets the maximum number of limits to return. If not specified, all the limits are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21379,17 +22517,17 @@ def add( """ Creates a new quota. An example of creating a new quota: - [source] - ---- + + ``` POST /ovirt-engine/api/datacenters/123/quotas - ---- - [source,xml] - ---- + ``` + + ```xml myquota My new quota for virtual machines - ---- + ``` """ @@ -21420,16 +22558,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of quota descriptors to return. If not specified all the descriptors are returned. + `max` \n + Sets the maximum number of quota descriptors to return. If not specified all the descriptors are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21489,13 +22632,13 @@ def get( ): """ Get the role. - [source] - ---- + + ``` GET /ovirt-engine/api/roles/123 - ---- + ``` You will receive XML response like this one: - [source,xml] - ---- + + ```xml MyRole MyRole description @@ -21503,19 +22646,23 @@ def get( true false - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21541,21 +22688,25 @@ def remove( """ Removes the role. To remove the role you need to know its id, then send request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/roles/{role_id} - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21586,33 +22737,37 @@ def update( ): """ Updates a role. You are allowed to update `name`, `description` and `administrative` attributes after role is - created. Within this endpoint you can't add or remove roles permits you need to use - xref:services-permits[service] that manages permits of role. + created. Within this endpoint you can't add or remove roles permits you need to use `PermitsService` + that manages permits of role. For example to update role's `name`, `description` and `administrative` attributes send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/roles/123 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml MyNewRoleName My new description of the role true - ---- + ``` This method supports the following parameters: - `role`:: Updated role. + `role` \n + Updated role. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21678,13 +22833,13 @@ def add( Create a new role. The role can be administrative or non-administrative and can have different permits. For example, to add the `MyRole` non-administrative role with permits to login and create virtual machines send a request like this (note that you have to pass permit id): - [source] - ---- + + ``` POST /ovirt-engine/api/roles - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml MyRole My custom role to create virtual machines @@ -21694,18 +22849,22 @@ def add( - ---- + ``` This method supports the following parameters: - `role`:: Role that will be added. + `role` \n + Role that will be added. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21729,13 +22888,13 @@ def list( ): """ List roles. - [source] - ---- + + ``` GET /ovirt-engine/api/roles - ---- + ``` You will receive response in XML like this one: - [source,xml] - ---- + + ```xml SuperUser @@ -21746,22 +22905,27 @@ def list( ... - ---- + ``` The order of the returned list of roles isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of roles to return. If not specified all the roles are returned. + `max` \n + Sets the maximum number of roles to return. If not specified all the roles are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21856,18 +23020,24 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of policies to return. If not specified all the policies are returned. + `max` \n + Sets the maximum number of policies to return. If not specified all the policies are returned. - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21935,16 +23105,21 @@ def get( """ This method supports the following parameters: - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -21974,13 +23149,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22091,16 +23270,21 @@ def get( """ This method supports the following parameters: - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22130,13 +23314,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22195,18 +23383,24 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of policy units to return. If not specified all the policy units are returned. + `max` \n + Sets the maximum number of policy units to return. If not specified all the policy units are returned. - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22273,14 +23467,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22307,21 +23505,26 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `all_content`:: Indicates if all the attributes of the virtual machine snapshot should be included in the response. - By default the attribute `initialization.configuration.data` is excluded. + `all_content` \n + Indicates if all the attributes of the virtual machine snapshot should be included in the response. + By default the attribute `ovirtsdk4.types.Initialization.configuration` is excluded. For example, to retrieve the complete representation of the snapshot with id `456` of the virtual machine with id `123` send a request like this: - .... + ``` GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true - .... + ``` - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22359,31 +23562,32 @@ def restore( Restores a virtual machine snapshot. For example, to restore the snapshot with identifier `456` of virtual machine with identifier `123` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/vms/123/snapshots/456/restore - ---- + ``` With an empty `action` in the body: - [source,xml] - ---- + + ```xml - ---- + ``` NOTE: Confirm that the commit operation is finished and the virtual machine is down before running the virtual machine. This method supports the following parameters: - `disks`:: Specify the disks included in the snapshot's restore. + `disks` \n + Specify the disks included in the snapshot's restore. For each disk parameter, it is also required to specify its `image_id`. For example, to restore a snapshot with an identifier `456` of a virtual machine with identifier `123`, including a disk with identifier `111` and `image_id` of `222`, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/vms/123/snapshots/456/restore - ---- + ``` Request body: - [source,xml] - ---- + + ```xml @@ -22391,15 +23595,19 @@ def restore( - ---- + ``` - `async_`:: Indicates if the restore should be performed asynchronously. + `async_` \n + Indicates if the restore should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22479,14 +23687,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22539,16 +23751,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of CDROMS to return. If not specified all the CDROMS are returned. + `max` \n + Sets the maximum number of CDROMS to return. If not specified all the CDROMS are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22608,14 +23825,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22668,16 +23889,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of disks to return. If not specified all the disks are returned. + `max` \n + Sets the maximum number of disks to return. If not specified all the disks are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22737,14 +23963,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22797,16 +24027,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of NICs to return. If not specified all the NICs are returned. + `max` \n + Sets the maximum number of NICs to return. If not specified all the NICs are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -22869,17 +24104,17 @@ def add( """ Creates a virtual machine snapshot. For example, to create a new snapshot for virtual machine `123` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/vms/123/snapshots - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml My snapshot - ---- + ``` For including only a sub-set of disks in the snapshots, add `disk_attachments` element to the request body. Note that disks which are not specified in `disk_attachments` element will not be a part of the snapshot. If an empty `disk_attachments` element is passed, the snapshot will include @@ -22889,8 +24124,8 @@ def add( This is used in order to restore a chain of images from backup. I.e. when restoring a disk with snapshots, the relevant `image_id` should be specified for each snapshot (so the identifiers of the disk snapshots are identical to the backup). - [source,xml] - ---- + + ```xml My snapshot @@ -22901,21 +24136,21 @@ def add( - ---- + ``` [IMPORTANT] ==== - When a snapshot is created, the default value for the - xref:types-snapshot-attributes-persist_memorystate[persist_memorystate] attribute is `true`. That means that the content of the memory of the virtual - machine will be included in the snapshot, and it also means that the virtual machine will be paused - for a longer time. That can negatively affect applications that are very sensitive to timing (NTP + When a snapshot is created, the default value for the `ovirtsdk4.types.Snapshot.persist_memorystate` attribute is `true`. + That means that the content of the memory of the virtual machine will be included in the snapshot, + and it also means that the virtual machine will be pausedfor a longer time. + That can negatively affect applications that are very sensitive to timing (NTP servers, for example). In those cases make sure that you set the attribute to `false`: - [source,xml] - ---- + + ```xml My snapshot false - ---- + ``` ==== @@ -22948,24 +24183,30 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of snapshots to return. If not specified all the snapshots are returned. + `max` \n + Sets the maximum number of snapshots to return. If not specified all the snapshots are returned. - `all_content`:: Indicates if all the attributes of the virtual machine snapshot should be included in the response. - By default the attribute `initialization.configuration.data` is excluded. + `all_content` \n + Indicates if all the attributes of the virtual machine snapshot should be included in the response. + By default the attribute `ovirtsdk4.types.Initialization.configuration` is excluded. For example, to retrieve the complete representation of the virtual machine with id `123` snapshots send a request like this: - .... + ``` GET /ovirt-engine/api/vms/123/snapshots?all_content=true - .... + ``` - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23029,14 +24270,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23062,13 +24307,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23100,9 +24349,7 @@ def update( """ Replaces the key with a new resource. IMPORTANT: Since version 4.4.8 of the engine this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. Instead please use DELETE followed by xref:services-ssh_public_keys-methods-add[add operation]. - - + compatibility. It will be removed in the future. Instead please use DELETE followed by `SshPublicKeysService.add`. """ # Check the types of the parameters: Service._check_types([ @@ -23177,23 +24424,23 @@ def list( Returns a list of SSH public keys of the user. For example, to retrieve the list of SSH keys of user with identifier `123`, send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/users/123/sshpublickeys - ---- + ``` The result will be the following XML document: - [source,xml] - ---- + + ```xml ssh-rsa ... - ---- + ``` Or the following JSON object - [source,json] - ---- + + ```json { "ssh_public_key": [ { @@ -23207,22 +24454,27 @@ def list( } ] } - ---- + ``` The order of the returned list of keys is not guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of keys to return. If not specified all the keys are returned. + `max` \n + Sets the maximum number of keys to return. If not specified all the keys are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23282,14 +24534,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23337,13 +24593,13 @@ def list( Retrieves a list of statistics. For example, to retrieve the statistics for virtual machine `123` send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/vms/123/statistics - ---- + ``` The result will be like this: - [source,xml] - ---- + + ```xml memory.installed @@ -23360,15 +24616,15 @@ def list( ... - ---- + ``` Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means: - [source] - ---- + + ``` GET /ovirt-engine/api/vms/123/statistics/456 - ---- + ``` Outputs: - [source,xml] - ---- + + ```xml memory.installed Total memory configured @@ -23382,22 +24638,27 @@ def list( - ---- + ``` The order of the returned list of statistics isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of statistics to return. If not specified all the statistics are returned. + `max` \n + Sets the maximum number of statistics to return. If not specified all the statistics are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23463,34 +24724,40 @@ def end( Marks an external step execution as ended. For example, to terminate a step with identifier `456` which belongs to a `job` with identifier `123` send the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/jobs/123/steps/456/end - ---- + ``` With the following request body: - [source,xml] - ---- + + ```xml true true - ---- + ``` This method supports the following parameters: - `force`:: Indicates if the step should be forcibly terminated. + `force` \n + Indicates if the step should be forcibly terminated. - `succeeded`:: Indicates if the step should be marked as successfully finished or as failed. + `succeeded` \n + Indicates if the step should be marked as successfully finished or as failed. This parameter is optional, and the default value is `true`. - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23523,13 +24790,13 @@ def get( ): """ Retrieves a step. - [source] - ---- + + ``` GET /ovirt-engine/api/jobs/123/steps/456 - ---- + ``` You will receive response in XML like this one: - [source,xml] - ---- + + ```xml @@ -23543,19 +24810,23 @@ def get( validating - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23613,23 +24884,23 @@ def add( Add an external step to an existing job or to an existing step. For example, to add a step to `job` with identifier `123` send the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/jobs/123/steps - ---- + ``` With the following request body: - [source,xml] - ---- + + ```xml Validating 2016-12-12T23:07:26.605+02:00 started validating - ---- + ``` The response should look like: - [source,xml] - ---- + + ```xml @@ -23643,18 +24914,22 @@ def add( validating - ---- + ``` This method supports the following parameters: - `step`:: Step that will be added. + `step` \n + Step that will be added. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23678,13 +24953,13 @@ def list( ): """ Retrieves the representation of the steps. - [source] - ---- + + ``` GET /ovirt-engine/api/job/123/steps - ---- + ``` You will receive response in XML like this one: - [source,xml] - ---- + + ```xml @@ -23701,22 +24976,27 @@ def list( ... - ---- + ``` The order of the returned list of steps isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of steps to return. If not specified all the steps are returned. + `max` \n + Sets the maximum number of steps to return. If not specified all the steps are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23779,14 +25059,15 @@ def get( """ This method supports the following parameters: - `report_status`:: Indicates if the status of the LUNs in the storage should be checked. + `report_status` \n + Indicates if the status of the LUNs in the storage should be checked. Checking the status of the LUN is an heavy weight operation and this data is not always needed by the user. This parameter will give the option to not perform the status check of the LUNs. The default is `true` for backward compatibility. Here an example with the LUN status : - [source,xml] - ---- + + ```xml @@ -23803,10 +25084,10 @@ def get( iscsi - ---- + ``` Here an example without the LUN status : - [source,xml] - ---- + + ```xml @@ -23822,16 +25103,20 @@ def get( iscsi - ---- + ``` - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23893,16 +25178,21 @@ def get( This method supports the following parameters: - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23938,15 +25228,20 @@ def is_attached( This method supports the following parameters: - `host`:: Indicates the data center's host. + `host` \n + Indicates the data center's host. - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -23980,33 +25275,37 @@ def reduce_luns( In order to do so the data stored on the provided logical units will be moved to other logical units of the storage domain and only then they will be reduced from the storage domain. For example, in order to reduce two logical units from a storage domain send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/storageDomains/123/reduceluns - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml - ---- - Note that this operation is only applicable to block storage domains (i.e., storage domains with the - xref:types-storage_type[storage type] of iSCSI or FCP). + ``` + Note that this operation is only applicable to block storage domains (i.e., storage domains with the + `ovirtsdk4.types.StorageType` of iSCSI or FCP). This method supports the following parameters: - `logical_units`:: The logical units that need to be reduced from the storage domain. + `logical_units` \n + The logical units that need to be reduced from the storage domain. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24037,33 +25336,38 @@ def refresh_luns( This action forces a rescan of the provided LUNs and updates the database with the new size, if required. For example, in order to refresh the size of two LUNs send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/storageDomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml - ---- + ``` This method supports the following parameters: - `logical_units`:: The LUNs that need to be refreshed. + `logical_units` \n + The LUNs that need to be refreshed. - `async_`:: Indicates if the refresh should be performed asynchronously. + `async_` \n + Indicates if the refresh should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24108,40 +25412,47 @@ def remove( This method supports the following parameters: - `host`:: Indicates which host should be used to remove the storage domain. + `host` \n + Indicates which host should be used to remove the storage domain. This parameter is mandatory, except if the `destroy` parameter is included and its value is `true`, in that case the `host` parameter will be ignored. The value should contain the name or the identifier of the host. For example, to use the host named `myhost` to remove the storage domain with identifier `123` send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/storageDomains/123?host=myhost - ---- + ``` - `format`:: Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or + `format` \n + Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or directory: - [source] - ---- + + ``` DELETE /ovirt-engine/api/storageDomains/123?format=true - ---- + ``` This parameter is optional, and the default value is `false`. - `destroy`:: Indicates if the operation should succeed, and the storage domain removed from the database, even if the + `destroy` \n + Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage is not accessible. - [source] - ---- + + ``` DELETE /ovirt-engine/api/storageDomains/123?destroy=true - ---- + ``` This parameter is optional, and the default value is `false`. When the value of `destroy` is `true` the `host` parameter will be ignored. - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24183,35 +25494,39 @@ def update( ): """ Updates a storage domain. - Not all of the xref:types-storage_domain[StorageDomain]'s attributes are updatable after creation. Those that can be + Not all of the `ovirtsdk4.types.StorageDomain`'s attributes are updatable after creation. Those that can be updated are: `name`, `description`, `comment`, `warning_low_space_indicator`, `critical_space_action_blocker` and `wipe_after_delete.` (Note that changing the `wipe_after_delete` attribute will not change the wipe after delete property of disks that already exist). To update the `name` and `wipe_after_delete` attributes of a storage domain with an identifier `123`, send a request as follows: - [source] - ---- + + ``` PUT /ovirt-engine/api/storageDomains/123 - ---- + ``` With a request body as follows: - [source,xml] - ---- + + ```xml data2 true - ---- + ``` This method supports the following parameters: - `storage_domain`:: The updated storage domain. + `storage_domain` \n + The updated storage domain. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24258,13 +25573,17 @@ def update_ovf_store( This method supports the following parameters: - `async_`:: Indicates if the `OVF_STORE` update should be performed asynchronously. + `async_` \n + Indicates if the `OVF_STORE` update should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24401,16 +25720,21 @@ def get( """ This method supports the following parameters: - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24470,22 +25794,29 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of disks to return. If not specified all the disks are returned. + `max` \n + Sets the maximum number of disks to return. If not specified all the disks are returned. - `search`:: A query string used to restrict the returned disks. + `search` \n + A query string used to restrict the returned disks. - `case_sensitive`:: Indicates if the search performed using the `search` parameter should be performed taking case into + `case_sensitive` \n + Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24540,8 +25871,8 @@ class StorageDomainDiskService(MeasurableService): IMPORTANT: Since version 4.2 of the engine this service is intended only to list disks available in the storage domain, and to register unregistered disks. All the other operations, like copying a disk, moving a disk, etc, have been deprecated and will be removed in the future. To perform those operations - use the xref:services-disks[service that manages all the disks of the system] - or the xref:services-disk[service that manages a specific disk]. + use the `DisksService` service that manages all the disks of the system, + or the `DiskService` service that manages a specific disk. """ @@ -24562,21 +25893,26 @@ def copy( """ Copies a disk to the specified storage domain. IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. To copy a disk use the xref:services-disk-methods-copy[copy] + compatibility. It will be removed in the future. To copy a disk use the `DiskService.copy` operation of the service that manages that disk. This method supports the following parameters: - `disk`:: Description of the resulting disk. + `disk` \n + Description of the resulting disk. - `storage_domain`:: The storage domain where the new disk will be created. + `storage_domain` \n + The storage domain where the new disk will be created. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24604,19 +25940,23 @@ def export( """ Exports a disk to an export storage domain. IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. To export a disk use the xref:services-disk-methods-export[export] + compatibility. It will be removed in the future. To export a disk use the `DiskService.export` operation of the service that manages that disk. This method supports the following parameters: - `storage_domain`:: The export storage domain where the disk should be exported to. + `storage_domain` \n + The export storage domain where the disk should be exported to. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24645,14 +25985,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24680,23 +26024,28 @@ def move( """ Moves a disk to another storage domain. IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. To move a disk use the xref:services-disk-methods-move[move] + compatibility. It will be removed in the future. To move a disk use the `DiskService.move` operation of the service that manages that disk. - This method supports the following parameters: - `storage_domain`:: The storage domain where the disk will be moved to. + `storage_domain` \n + The storage domain where the disk will be moved to. - `async_`:: Indicates if the move should be performed asynchronously. + `async_` \n + Indicates if the move should be performed asynchronously. - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24736,13 +26085,17 @@ def reduce( This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24771,7 +26124,7 @@ def remove( """ Removes a disk. IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. To remove a disk use the xref:services-disk-methods-remove[remove] + compatibility. It will be removed in the future. To remove a disk use the `DiskService.remove` operation of the service that manages that disk. @@ -24796,7 +26149,7 @@ def sparsify( """ Sparsify the disk. IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. To remove a disk use the xref:services-disk-methods-remove[remove] + compatibility. It will be removed in the future. To remove a disk use the `DiskService.remove` operation of the service that manages that disk. @@ -24823,19 +26176,23 @@ def update( """ Updates the disk. IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. To update a disk use the - xref:services-disk-methods-update[update] operation of the service that manages that disk. + compatibility. It will be removed in the future. To update a disk use the `DiskService.update` operation + of the service that manages that disk. This method supports the following parameters: - `disk`:: The update to apply to the disk. + `disk` \n + The update to apply to the disk. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24902,21 +26259,23 @@ def add( """ Adds or registers a disk. IMPORTANT: Since version 4.2 of the {engine-name} this operation is deprecated, and preserved only for backwards - compatibility. It will be removed in the future. To add a new disk use the xref:services-disks-methods-add[add] + compatibility. It will be removed in the future. To add a new disk use the `DisksService.add` operation of the service that manages the disks of the system. To register an unregistered disk use the - xref:services-attached_storage_domain_disk-methods-register[register] operation of the service that manages - that disk. - + `AttachedStorageDomainDiskService.register` operation of the service that manages that disk. This method supports the following parameters: - `disk`:: The disk to add or register. + `disk` \n + The disk to add or register. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -24950,25 +26309,31 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of disks to return. If not specified, all the disks are returned. + `max` \n + Sets the maximum number of disks to return. If not specified, all the disks are returned. - `unregistered`:: Indicates whether to retrieve a list of registered or unregistered disks in the storage domain. + `unregistered` \n + Indicates whether to retrieve a list of registered or unregistered disks in the storage domain. To get a list of unregistered disks in the storage domain the call should indicate the unregistered flag. For example, to get a list of unregistered disks the REST API call should look like this: - .... + ``` GET /ovirt-engine/api/storagedomains/123/disks?unregistered=true - .... + ``` The default value of the unregistered flag is `false`. The request only applies to storage domains that are attached. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25034,14 +26399,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25070,13 +26439,17 @@ def remove( This method supports the following parameters: - `async_`:: Indicates if the action should be performed asynchronously. + `async_` \n + Indicates if the action should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25155,16 +26528,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of connections to return. If not specified all the connections are returned. + `max` \n + Sets the maximum number of connections to return. If not specified all the connections are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25225,14 +26603,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25264,13 +26646,12 @@ def import_( """ Action to import a template from an export storage domain. For example, to import the template `456` from the storage domain `123` send the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/storagedomains/123/templates/456/import - ---- + ``` With the following request body: - [source, xml] - ---- + ```xml myexport @@ -25279,7 +26660,7 @@ def import_( mycluster - ---- + ``` If you register an entity without specifying the cluster ID or name, the cluster name from the entity's OVF will be used (unless the register request also includes the cluster mapping). @@ -25287,17 +26668,22 @@ def import_( This method supports the following parameters: - `clone`:: Use the optional `clone` parameter to generate new UUIDs for the imported template and its entities. + `clone` \n + Use the optional `clone` parameter to generate new UUIDs for the imported template and its entities. You can import a template with the `clone` parameter set to `false` when importing a template from an export domain, with templates that were exported by a different {product-name} environment. - `async_`:: Indicates if the import should be performed asynchronously. + `async_` \n + Indicates if the import should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25350,29 +26736,36 @@ def register( This method supports the following parameters: - `allow_partial_import`:: Indicates whether a template is allowed to be registered with only some of its disks. + `allow_partial_import` \n + Indicates whether a template is allowed to be registered with only some of its disks. If this flag is `true`, the system will not fail in the validation process if an image is not found, but instead it will allow the template to be registered without the missing disks. This is mainly used during registration of a template when some of the storage domains are not available. The default value is `false`. - `vnic_profile_mappings`:: Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the import\register process. + `vnic_profile_mappings` \n + Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the import\register process. WARNING: Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future. To specify `vnic_profile_mappings` use the `vnic_profile_mappings` - attribute inside the xref:types-registration_configuration[RegistrationConfiguration] type. + attribute inside the `ovirtsdk4.types.RegistrationConfiguration` type. - `registration_configuration`:: This parameter describes how the template should be + `registration_configuration` \n + This parameter describes how the template should be registered. This parameter is optional. If the parameter is not specified, the template will be registered with the same configuration that it had in the original environment where it was created. - `async_`:: Indicates if the registration should be performed asynchronously. + `async_` \n + Indicates if the registration should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25416,13 +26809,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25490,25 +26887,31 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of templates to return. If not specified all the templates are returned. + `max` \n + Sets the maximum number of templates to return. If not specified all the templates are returned. - `unregistered`:: Indicates whether to retrieve a list of registered or unregistered templates which contain disks on the storage domain. + `unregistered` \n + Indicates whether to retrieve a list of registered or unregistered templates which contain disks on the storage domain. To get a list of unregistered templates the call should indicate the unregistered flag. For example, to get a list of unregistered templates the REST API call should look like this: - .... + ``` GET /ovirt-engine/api/storagedomains/123/templates?unregistered=true - .... + ``` The default value of the unregisterd flag is `false`. The request only apply to storage domains that are attached. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25574,14 +26977,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25613,13 +27020,13 @@ def import_( """ Imports a virtual machine from an export storage domain. For example, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/storagedomains/123/vms/456/import - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml mydata @@ -25628,10 +27035,10 @@ def import_( mycluster - ---- + ``` To import a virtual machine as a new entity add the `clone` parameter: - [source,xml] - ---- + + ```xml mydata @@ -25644,11 +27051,11 @@ def import_( myvm - ---- + ``` Include an optional `disks` parameter to choose which disks to import. For example, to import the disks of the template that have the identifiers `123` and `456` send the following request body: - [source,xml] - ---- + + ```xml mycluster @@ -25661,7 +27068,7 @@ def import_( - ---- + ``` If you register an entity without specifying the cluster ID or name, the cluster name from the entity's OVF will be used (unless the register request also includes the cluster mapping). @@ -25669,7 +27076,8 @@ def import_( This method supports the following parameters: - `clone`:: Indicates if the identifiers of the imported virtual machine + `clone` \n + Indicates if the identifiers of the imported virtual machine should be regenerated. By default when a virtual machine is imported the identifiers are preserved. This means that the same virtual machine can't @@ -25677,19 +27085,24 @@ def import_( unique. To allow importing the same machine multiple times set this parameter to `true`, as the default is `false`. - `collapse_snapshots`:: Indicates of the snapshots of the virtual machine that is imported + `collapse_snapshots` \n + Indicates of the snapshots of the virtual machine that is imported should be collapsed, so that the result will be a virtual machine without snapshots. This parameter is optional, and if it isn't explicitly specified the default value is `false`. - `async_`:: Indicates if the import should be performed asynchronously. + `async_` \n + Indicates if the import should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25738,35 +27151,43 @@ def register( """ This method supports the following parameters: - `allow_partial_import`:: Indicates whether a virtual machine is allowed to be registered with only some of its disks. + `allow_partial_import` \n + Indicates whether a virtual machine is allowed to be registered with only some of its disks. If this flag is `true`, the engine will not fail in the validation process if an image is not found, but instead it will allow the virtual machine to be registered without the missing disks. This is mainly used during registration of a virtual machine when some of the storage domains are not available. The default value is `false`. - `vnic_profile_mappings`:: Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the import\register process. + `vnic_profile_mappings` \n + Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the import\register process. WARNING: Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future. To specify `vnic_profile_mappings` use the `vnic_profile_mappings` - attribute inside the xref:types-registration_configuration[RegistrationConfiguration] type. + attribute inside the `ovirtsdk4.types.RegistrationConfiguration` type. - `reassign_bad_macs`:: Indicates if the problematic MAC addresses should be re-assigned during the import process by the engine. + `reassign_bad_macs` \n + Indicates if the problematic MAC addresses should be re-assigned during the import process by the engine. A MAC address would be considered as a problematic one if one of the following is true: - It conflicts with a MAC address that is already allocated to a virtual machine in the target environment. - It's out of the range of the target MAC address pool. - `registration_configuration`:: This parameter describes how the virtual machine should be + `registration_configuration` \n + This parameter describes how the virtual machine should be registered. This parameter is optional. If the parameter is not specified, the virtual machine will be registered with the same configuration that it had in the original environment where it was created. - `async_`:: Indicates if the registration should be performed asynchronously. + `async_` \n + Indicates if the registration should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25810,21 +27231,25 @@ def remove( """ Deletes a virtual machine from an export storage domain. For example, to delete the virtual machine `456` from the storage domain `123`, send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/storagedomains/123/vms/456 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25899,14 +27324,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -25958,14 +27387,18 @@ def list( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26010,13 +27443,13 @@ class StorageDomainVmsService(Service): Lists the virtual machines of an export storage domain. For example, to retrieve the virtual machines that are available in the storage domain with identifier `123` send the following request: - [source] - ---- + + ``` GET /ovirt-engine/api/storagedomains/123/vms - ---- + ``` This will return the following response body: - [source,xml] - ---- + + ```xml vm1 @@ -26027,12 +27460,10 @@ class StorageDomainVmsService(Service): - ---- + ``` Virtual machines and templates in these collections have a similar representation to their counterparts in the - top-level xref:types-vm[Vm] and xref:types-template[Template] collections, except they also contain a - xref:types-storage_domain[StorageDomain] reference and an xref:services-storage_domain_vm-methods-import[import] - action. - + top-level `ovirtsdk4.types.Vm` and `ovirtsdk4.types.Template` collections, except they also contain a + `ovirtsdk4.types.StorageDomain` reference and an `StorageDomainVmService.import_` action. """ def __init__(self, connection, path): @@ -26056,27 +27487,33 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of virtual machines to return. If not specified all the virtual machines are + `max` \n + Sets the maximum number of virtual machines to return. If not specified all the virtual machines are returned. - `unregistered`:: Indicates whether to retrieve a list of registered or unregistered virtual machines which + `unregistered` \n + Indicates whether to retrieve a list of registered or unregistered virtual machines which contain disks on the storage domain. To get a list of unregistered virtual machines the call should indicate the unregistered flag. For example, to get a list of unregistered virtual machines the REST API call should look like this: - .... + ``` GET /ovirt-engine/api/storagedomains/123/vms?unregistered=true - .... + ``` The default value of the unregisterd flag is `false`. The request only apply to storage domains that are attached. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26142,20 +27579,20 @@ def add( ): """ Adds a new storage domain. - Creation of a new xref:types-storage_domain[StorageDomain] requires the `name`, `type`, `host`, and `storage` + Creation of a new `ovirtsdk4.types.StorageDomain` requires the `name`, `type`, `host`, and `storage` attributes. Identify the `host` attribute with the `id` or `name` attributes. In {product-name} 3.6 and later you can enable the wipe after delete option by default on the storage domain. To configure this, specify `wipe_after_delete` in the POST request. This option can be edited after the domain is created, but doing so will not change the wipe after delete property of disks that already exist. To add a new storage domain with specified `name`, `type`, `storage.type`, `storage.address`, and `storage.path`, and using a host with an id `123`, send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/storageDomains - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml mydata data @@ -26168,10 +27605,10 @@ def add( myhost - ---- + ``` To create a new NFS ISO storage domain send a request like this: - [source,xml] - ---- + + ```xml myisos iso @@ -26184,10 +27621,10 @@ def add( myhost - ---- + ``` To create a new iSCSI storage domain send a request like this: - [source,xml] - ---- + + ```xml myiscsi data @@ -26202,18 +27639,22 @@ def add( myhost - ---- + ``` This method supports the following parameters: - `storage_domain`:: The storage domain to add. + `storage_domain` \n + The storage domain to add. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26240,13 +27681,17 @@ def add_block_domain( This method supports the following parameters: - `storage_domain`:: The storage domain to add. + `storage_domain` \n + The storage domain to add. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26273,13 +27718,17 @@ def add_by_path( This method supports the following parameters: - `storage_domain`:: The storage domain to add. + `storage_domain` \n + The storage domain to add. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26306,13 +27755,17 @@ def add_direct_lun( This method supports the following parameters: - `storage_domain`:: The storage domain to add. + `storage_domain` \n + The storage domain to add. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26339,13 +27792,17 @@ def add_gluster_or_postfs( This method supports the following parameters: - `storage_domain`:: The storage domain to add. + `storage_domain` \n + The storage domain to add. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26378,24 +27835,32 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of storage domains to return. If not specified, all the storage domains are returned. + `max` \n + Sets the maximum number of storage domains to return. If not specified, all the storage domains are returned. - `search`:: A query string used to restrict the returned storage domains. + `search` \n + A query string used to restrict the returned storage domains. - `case_sensitive`:: Indicates if the search should be performed taking case into account. + `case_sensitive` \n + Indicates if the search should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case, set it to `false`. - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26439,13 +27904,17 @@ def add_local( This method supports the following parameters: - `storage_domain`:: The storage domain to add. + `storage_domain` \n + The storage domain to add. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26499,14 +27968,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26690,22 +28163,27 @@ def remove( This method supports the following parameters: - `host`:: The name or identifier of the host from which the connection would be unmounted (disconnected). If not + `host` \n + The name or identifier of the host from which the connection would be unmounted (disconnected). If not provided, no host will be disconnected. For example, to use the host with identifier `456` to delete the storage connection with identifier `123` send a request like this: - [source] - ---- + + ``` DELETE /ovirt-engine/api/storageconnections/123?host=456 - ---- + ``` - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26741,30 +28219,28 @@ def update( """ Updates the storage connection. For example, to change the address of an NFS storage server, send a request like this: - [source,xml] - ---- + ``` PUT /ovirt-engine/api/storageconnections/123 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml
mynewnfs.example.com
 - ---- + ``` To change the connection of an iSCSI storage server, send a request like this: - [source,xml] - ---- + ``` PUT /ovirt-engine/api/storageconnections/123 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml 3260 iqn.2017-01.com.myhost:444 - ---- + ``` """ @@ -26859,14 +28335,18 @@ def get( """ This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26892,13 +28372,17 @@ def remove( """ This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -26930,19 +28414,19 @@ def update( """ Update a storage server connection extension for the given host. To update the storage connection `456` of host `123` send a request like this: - [source] - ---- + + ``` PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456 - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml iqn.2016-01.com.example:mytarget myuser mypassword - ---- + ``` """ @@ -26998,19 +28482,19 @@ def add( The extension lets the user define credentials for an iSCSI target for a specific host. For example to use `myuser` and `mypassword` as the credentials when connecting to the iSCSI target from host `123` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/hosts/123/storageconnectionextensions - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml iqn.2016-01.com.example:mytarget myuser mypassword - ---- + ``` """ @@ -27041,16 +28525,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of extensions to return. If not specified all the extensions are returned. + `max` \n + Sets the maximum number of extensions to return. If not specified all the extensions are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -27112,13 +28601,13 @@ def add( Creates a new storage connection. For example, to create a new storage connection for the NFS server `mynfs.example.com` and NFS share `/export/mydata` send a request like this: - [source] - ---- + + ``` POST /ovirt-engine/api/storageconnections - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml nfs
mynfs.example.com
@@ -27127,7 +28616,7 @@ def add( myhost - ---- + ``` """ @@ -27206,16 +28695,21 @@ def list( This method supports the following parameters: - `max`:: Sets the maximum number of connections to return. If not specified all the connections are returned. + `max` \n + Sets the maximum number of connections to return. If not specified all the connections are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -27387,13 +28881,13 @@ def get( """ Returns basic information describing the API, like the product name, the version number and a summary of the number of relevant objects. - [source] - ---- + + ``` GET /ovirt-engine/api - ---- + ``` We get following response: - [source,xml] - ---- + + ```xml @@ -27453,7 +28947,7 @@ def get( - ---- + ``` The entry point provides a user with links to the collections in a virtualization environment. The `rel` attribute of each collection link provides a reference point for each link. @@ -27463,14 +28957,18 @@ def get( This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -27496,13 +28994,17 @@ def reload_configurations( """ This method supports the following parameters: - `async_`:: Indicates if the reload should be performed asynchronously. + `async_` \n + Indicates if the reload should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -27932,13 +29434,13 @@ def get( """ Get the values of specific configuration option. For example to retrieve the values of configuration option `MigrationPolicies` send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/options/MigrationPolicies - ---- + ``` The response to that request will be the following: - [source,xml] - ---- + + ```xml MigrationPolicies @@ -27969,7 +29471,7 @@ def get( - ---- + ``` NOTE: The appropriate permissions are required to query configuration options. Some options can be queried only by users with administrator permissions. [IMPORTANT] @@ -27977,25 +29479,24 @@ def get( There is NO backward compatibility and no guarantee about the names or values of the options. Options may be removed and their meaning can be changed at any point. We strongly discourage the use of this service for applications other than the ones that are released - simultaneously with the engine. Usage by other applications is not supported. Therefore there will be no - documentation listing accessible configuration options. + simultaneously with the engine. Usage by other applications is not supported. Therefore there will be no documentation listing accessible configuration options. ==== - This method supports the following parameters: - `version`:: Optional version parameter that specifies that only particular version of the configuration option + `version` \n + Optional version parameter that specifies that only particular version of the configuration option should be returned. If this parameter isn't used then all the versions will be returned. For example, to get the value of the `MigrationPolicies` option but only for version `4.2` send a request like this: - [source] - ---- + + ``` GET /ovirt-engine/api/options/MigrationPolicies?version=4.2 - ---- + ``` The response to that request will be like this: - [source,xml] - ---- + + ```xml MigrationPolicies @@ -28005,13 +29506,16 @@ def get( - ---- + ``` - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28096,60 +29600,64 @@ def add( Assign a new permission to a user or group for specific entity. For example, to assign the `UserVmManager` role to the virtual machine with id `123` to the user with id `456` send a request like this: - .... + ``` POST /ovirt-engine/api/vms/123/permissions - .... + ``` With a request body like this: - [source,xml] - ---- + + ```xml UserVmManager - ---- + ``` To assign the `SuperUser` role to the system to the user with id `456` send a request like this: - .... + ``` POST /ovirt-engine/api/permissions - .... + ``` With a request body like this: - [source,xml] - ---- + + ```xml SuperUser - ---- + ``` If you want to assign permission to the group instead of the user please replace the `user` element with the `group` element with proper `id` of the group. For example to assign the `UserRole` role to the cluster with id `123` to the group with id `789` send a request like this: - .... + ``` POST /ovirt-engine/api/clusters/123/permissions - .... + ``` With a request body like this: - [source,xml] - ---- + + ```xml UserRole - ---- + ``` This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28176,13 +29684,17 @@ def add_cluster_permission( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28209,13 +29721,17 @@ def add_data_center_permission( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28242,13 +29758,17 @@ def add_group_level( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28275,13 +29795,17 @@ def add_host_permission( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28305,11 +29829,11 @@ def list( """ List all the permissions of the specific entity. For example to list all the permissions of the cluster with id `123` send a request like this: - .... + ``` GET /ovirt-engine/api/clusters/123/permissions - .... - [source,xml] - ---- + ``` + + ```xml @@ -28322,20 +29846,24 @@ def list( - ---- + ``` The order of the returned permissions isn't guaranteed. This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28364,13 +29892,17 @@ def add_storage_domain_permission( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28397,13 +29929,17 @@ def add_template_permission( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28430,13 +29966,17 @@ def add_user_level( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28463,13 +30003,17 @@ def add_vm_permission( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28496,13 +30040,17 @@ def add_vm_pool_permission( This method supports the following parameters: - `permission`:: The permission. + `permission` \n + The permission. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28561,28 +30109,32 @@ def get( """ Gets the information about the tag. For example to retrieve the information about the tag with the id `123` send a request like this: - .... + ``` GET /ovirt-engine/api/tags/123 - .... - [source,xml] - ---- + ``` + + ```xml root root - ---- + ``` This method supports the following parameters: - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28608,20 +30160,24 @@ def remove( """ Removes the tag from the system. For example to remove the tag with id `123` send a request like this: - .... + ``` DELETE /ovirt-engine/api/tags/123 - .... + ``` This method supports the following parameters: - `async_`:: Indicates if the remove should be performed asynchronously. + `async_` \n + Indicates if the remove should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28653,37 +30209,41 @@ def update( """ Updates the tag entity. For example to update parent tag to tag with id `456` of the tag with id `123` send a request like this: - .... + ``` PUT /ovirt-engine/api/tags/123 - .... + ``` With request body like: - [source,xml] - ---- + + ```xml - ---- + ``` You may also specify a tag name instead of id. For example to update parent tag to tag with name `mytag` of the tag with id `123` send a request like this: - [source,xml] - ---- + + ```xml mytag - ---- + ``` This method supports the following parameters: - `tag`:: The updated tag. + `tag` \n + The updated tag. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28737,39 +30297,43 @@ def add( """ Add a new tag to the system. For example, to add new tag with name `mytag` to the system send a request like this: - .... + ``` POST /ovirt-engine/api/tags - .... + ``` With a request body like this: - [source,xml] - ---- + + ```xml mytag - ---- + ``` NOTE: The root tag is a special pseudo-tag assumed as the default parent tag if no parent tag is specified. The root tag cannot be deleted nor assigned a parent tag. To create new tag with specific parent tag send a request body like this: - [source,xml] - ---- + + ```xml mytag myparenttag - ---- + ``` This method supports the following parameters: - `tag`:: The added tag. + `tag` \n + The added tag. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28794,11 +30358,11 @@ def list( """ List the tags in the system. For example to list the full hierarchy of the tags in the system send a request like this: - .... + ``` GET /ovirt-engine/api/tags - .... - [source,xml] - ---- + ``` + + ```xml root2 @@ -28815,28 +30379,33 @@ def list( root - ---- + ``` In the previous XML output you can see the following hierarchy of the tags: - .... + ``` root: (id: 111) - root2 (id: 222) - root3 (id: 333) - .... + ``` The order of the returned list of tags isn't guaranteed. This method supports the following parameters: - `max`:: Sets the maximum number of tags to return. If not specified all the tags are returned. + `max` \n + Sets the maximum number of tags to return. If not specified all the tags are returned. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28909,27 +30478,27 @@ def export( """ Exports a template to the data center export domain. For example, send the following request: - [source] - ---- + + ``` POST /ovirt-engine/api/templates/123/export - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml true - ---- + ``` Since version 4.2 of the engine it is also possible to export a template as a virtual appliance (OVA). For example, to export template `123` as an OVA file named `myvm.ova` that is placed in the directory `/home/ovirt/` on host `myhost`: - [source] - ---- + + ``` POST /ovirt-engine/api/templates/123/export - ---- + ``` With a request body like this: - [source,xml] - ---- + + ```xml myhost @@ -28937,22 +30506,27 @@ def export( /home/ovirt myvm.ova - ---- + ``` This method supports the following parameters: - `exclusive`:: Indicates if the existing templates with the same name should be overwritten. + `exclusive` \n + Indicates if the existing templates with the same name should be overwritten. The export action reports a failed action if a template of the same name exists in the destination domain. Set this parameter to `true` to change this behavior and overwrite any existing template. - `storage_domain`:: Specifies the destination export storage domain. + `storage_domain` \n + Specifies the destination export storage domain. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -28984,16 +30558,21 @@ def get( This method supports the following parameters: - `filter`:: Indicates if the results should be filtered according to the permissions of the user. + `filter` \n + Indicates if the results should be filtered according to the permissions of the user. - `follow`:: Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part - of the current request. See <> for details. + `follow` \n + Indicates which inner links should be followed. The objects referenced by these links will be fetched as part + of the current request. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -29022,21 +30601,25 @@ def remove( ): """ Removes a virtual machine template. - [source] - ---- + + ``` DELETE /ovirt-engine/api/templates/123 - ---- + ``` This method supports the following parameters: - `async_`:: Indicates if the removal should be performed asynchronously. + `async_` \n + Indicates if the removal should be performed asynchronously. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -29071,17 +30654,22 @@ def export_to_export_domain( This method supports the following parameters: - `exclusive`:: Indicates if the existing templates with the same name should be overwritten. + `exclusive` \n + Indicates if the existing templates with the same name should be overwritten. The export action reports a failed action if a template of the same name exists in the destination domain. Set this parameter to `true` to change this behavior and overwrite any existing template. - `storage_domain`:: Specifies the destination export storage domain. + `storage_domain` \n + Specifies the destination export storage domain. - `headers`:: Additional HTTP headers. + `headers` \n + Additional HTTP headers. - `query`:: Additional URL query parameters. + `query` \n + Additional URL query parameters. - `wait`:: If `True` wait for the response. + `wait` \n + If `True` wait for the response. """ # Check the types of the parameters: Service._check_types([ @@ -29116,25 +30704,33 @@ def export_to_path_on_host( This method supports the following parameters: - `host`:: The host to generate the OVA file on. + `host` \n + The host to generate the OVA file on. - `directory`:: An absolute path of a directory on the host to generate the OVA file in. + `directory` \n + An absolute path of a directory on the host to generate the OVA file in. - `filename`:: The name of the OVA file. + `filename` \n + The name of the OVA file. This is an optional parameter. If it is not specified, the name of the OVA file is determined according - to the name of the template. It will conform to the following pattern: "