File: Config.rst

package info (click to toggle)
python-pyvmomi 6.7.1-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 14,984 kB
  • sloc: python: 9,206; xml: 77; makefile: 9
file content (82 lines) | stat: -rw-r--r-- 3,653 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
.. _str: https://docs.python.org/2/library/stdtypes.html

.. _name: ../../../vim/dvs/EntityBackup/Config.rst#name

.. _uuid: ../../../vim/DistributedVirtualSwitch.rst#uuid

.. _base64: https://docs.python.org/2/library/stdtypes.html

.. _Folder: ../../../vim/Folder.rst

.. _container: ../../../vim/dvs/EntityBackup/Config.rst#container

.. _entityType: ../../../vim/dvs/EntityBackup/Config.rst#entityType

.. _EntityType: ../../../vim/dvs/EntityBackup/EntityType.rst

.. _vSphere API 5.1: ../../../vim/version.rst#vimversionversion8

.. _EntityImportType: ../../../vim/dvs/EntityBackup/ImportType.rst

.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst

.. _vim.ManagedEntity: ../../../vim/ManagedEntity.rst

.. _EntityBackupConfig: ../../../vim/dvs/EntityBackup/Config.rst

.. _applyToEntitySpecified: ../../../vim/dvs/EntityBackup/ImportType.rst#applyToEntitySpecified

.. _DistributedVirtualSwitch: ../../../vim/DistributedVirtualSwitch.rst

.. _DistributedVirtualPortgroup: ../../../vim/dvs/DistributedVirtualPortgroup.rst

.. _DVSManagerImportEntity_Task: ../../../vim/dvs/DistributedVirtualSwitchManager.rst#importEntity

.. _DVSManagerExportEntity_Task: ../../../vim/dvs/DistributedVirtualSwitchManager.rst#exportEntity

.. _VmwareDistributedVirtualSwitch: ../../../vim/dvs/VmwareDistributedVirtualSwitch.rst


vim.dvs.EntityBackup.Config
===========================
  The `EntityBackupConfig`_ data object contains `VmwareDistributedVirtualSwitch`_ or `DistributedVirtualPortgroup`_ backup configuration data produced by the `DVSManagerExportEntity_Task`_ method. It also contains properties that support `DVSManagerImportEntity_Task`_ operations.A `DVSManagerExportEntity_Task`_ operation sets properties that identify the entity instance ( `entityType`_ , `key`_ , and `name`_ ) and inventory location ( `container`_ ). When you import a backup configuration, you can set thekey,name, andcontainerproperties in accordance with theimportTypespecified in the call to `DVSManagerImportEntity_Task`_ . See `EntityImportType`_ .
:extends: vmodl.DynamicData_
:since: `vSphere API 5.1`_

Attributes:
    entityType (`str`_):

       Type of the exported entity ( `DVSManagerExportEntity_Task`_ ). See `EntityType`_ for valid values.
    configBlob (`base64`_):

       Opaque blob that contains the configuration of the entity.
    key (`str`_, optional):

       Unique identifier of the exported entity or the entity to be restored through an import operation.
        * If you are importing a virtual distributed switch and the import type is
        * `applyToEntitySpecified`_
        * , set the
        * key
        * to
        * `DistributedVirtualSwitch`_
        * .
        * `uuid`_
        * .
        * If you are importing a virtual distributed portgroup and the import type is
        * `applyToEntitySpecified`_
        * , set the
        * key
        * to
        * `DistributedVirtualPortgroup`_
        * .
        * `key`_
        * .The Server ignores the key value when the import operation creates a new entity.
    name (`str`_, optional):

       Name of the exported entity or the entity to be restored with the backup configuration. If you are importing an entity and the import type is `applyToEntitySpecified`_ , the Server will use this value to rename the existing entity.
    container (`vim.ManagedEntity`_, optional):

       Container for this entity. If `entityType`_ is "distributedVirtualSwitch", the container type is `Folder`_ . If `entityType`_ is "distributedVirtualPortgroup", the container type is `DistributedVirtualSwitch`_ .
    configVersion (`str`_, optional):

       Configuration version.