mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 01:39:58 -05:00
7.0U2 MP1 release Docs
Signed-off-by: Shweta Purohit <spurohit@vmware.com>
This commit is contained in:
parent
dd76e55f9b
commit
3f9a1d21a8
@ -1,5 +1,5 @@
|
||||
.. vSphere Automation SDK for Python. documentation master file, created by
|
||||
sphinx-quickstart on Wed Feb 3 01:48:32 2021.
|
||||
sphinx-quickstart on Tue May 11 09:42:31 2021.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
|
@ -277,25 +277,25 @@ p.rubric {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
img.align-left, figure.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right {
|
||||
img.align-right, figure.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
img.align-center, figure.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, .figure.align-default {
|
||||
img.align-default, figure.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
@ -319,7 +319,8 @@ img.align-default, .figure.align-default {
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
div.sidebar,
|
||||
aside.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px;
|
||||
@ -377,12 +378,14 @@ div.body p.centered {
|
||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||
|
||||
div.sidebar > :last-child,
|
||||
aside.sidebar > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sidebar::after,
|
||||
aside.sidebar::after,
|
||||
div.topic::after,
|
||||
div.admonition::after,
|
||||
blockquote::after {
|
||||
@ -455,20 +458,22 @@ td > :last-child {
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
div.figure, figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
div.figure p.caption, figcaption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
div.figure p.caption span.caption-number,
|
||||
figcaption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
div.figure p.caption span.caption-text,
|
||||
figcaption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
@ -29,9 +29,14 @@ if (!window.console || !console.firebug) {
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||
if (!x) {
|
||||
return x
|
||||
}
|
||||
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||
};
|
||||
|
||||
/**
|
||||
|
BIN
vsphere/7.0.2.0/_static/fonts/Inconsolata-Bold.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Inconsolata-Bold.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Inconsolata-Regular.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Inconsolata-Regular.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Inconsolata.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Inconsolata.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato-Bold.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato-Bold.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato-Regular.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato-Regular.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bold.eot
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bold.eot
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bold.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bold.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bold.woff
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bold.woff
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bold.woff2
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bold.woff2
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bolditalic.eot
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bolditalic.eot
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bolditalic.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bolditalic.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bolditalic.woff
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bolditalic.woff
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bolditalic.woff2
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-bolditalic.woff2
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-italic.eot
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-italic.eot
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-italic.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-italic.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-italic.woff
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-italic.woff
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-italic.woff2
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-italic.woff2
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-regular.eot
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-regular.eot
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-regular.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-regular.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-regular.woff
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-regular.woff
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-regular.woff2
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/Lato/lato-regular.woff2
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/RobotoSlab-Bold.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/RobotoSlab-Bold.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/RobotoSlab-Regular.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/RobotoSlab-Regular.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf
Normal file
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.eot
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.eot
Normal file
Binary file not shown.
2671
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.svg
Normal file
2671
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.svg
Normal file
File diff suppressed because it is too large
Load Diff
After Width: | Height: | Size: 434 KiB |
BIN
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.ttf
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.ttf
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.woff
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.woff
Normal file
Binary file not shown.
BIN
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.woff2
Normal file
BIN
vsphere/7.0.2.0/_static/fonts/fontawesome-webfont.woff2
Normal file
Binary file not shown.
4
vsphere/7.0.2.0/_static/js/modernizr.min.js
vendored
Normal file
4
vsphere/7.0.2.0/_static/js/modernizr.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
@ -13,7 +13,8 @@
|
||||
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||
|
||||
|
||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||
/* Non-minified version is copied as a separate JS file, is available */
|
||||
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
@ -199,7 +200,6 @@ var Stemmer = function() {
|
||||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
|
@ -1,7 +1,7 @@
|
||||
pre { line-height: 125%; }
|
||||
td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #f8f8f8; }
|
||||
|
@ -248,7 +248,7 @@ var Search = {
|
||||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li style="display:none"></li>');
|
||||
var listItem = $('<li></li>');
|
||||
var requestUrl = "";
|
||||
var linkUrl = "";
|
||||
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||
@ -273,9 +273,9 @@ var Search = {
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}, 5);
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
$.ajax({url: requestUrl,
|
||||
dataType: "text",
|
||||
@ -285,16 +285,16 @@ var Search = {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}, 5);
|
||||
}});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}, 5);
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
@ -379,6 +379,13 @@ var Search = {
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
||||
*/
|
||||
escapeRegExp : function(string) {
|
||||
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
@ -402,13 +409,14 @@ var Search = {
|
||||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
var word_regex = this.escapeRegExp(word);
|
||||
for (var w in terms) {
|
||||
if (w.match(word) && !terms[word]) {
|
||||
if (w.match(word_regex) && !terms[word]) {
|
||||
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||
}
|
||||
}
|
||||
for (var w in titleterms) {
|
||||
if (w.match(word) && !titleterms[word]) {
|
||||
if (w.match(word_regex) && !titleterms[word]) {
|
||||
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||
}
|
||||
}
|
||||
|
2027
vsphere/7.0.2.0/_static/underscore-1.12.0.js
Normal file
2027
vsphere/7.0.2.0/_static/underscore-1.12.0.js
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,999 +0,0 @@
|
||||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
|
||||
(function() {
|
||||
|
||||
// Baseline setup
|
||||
// --------------
|
||||
|
||||
// Establish the root object, `window` in the browser, or `global` on the server.
|
||||
var root = this;
|
||||
|
||||
// Save the previous value of the `_` variable.
|
||||
var previousUnderscore = root._;
|
||||
|
||||
// Establish the object that gets returned to break out of a loop iteration.
|
||||
var breaker = {};
|
||||
|
||||
// Save bytes in the minified (but not gzipped) version:
|
||||
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
|
||||
|
||||
// Create quick reference variables for speed access to core prototypes.
|
||||
var slice = ArrayProto.slice,
|
||||
unshift = ArrayProto.unshift,
|
||||
toString = ObjProto.toString,
|
||||
hasOwnProperty = ObjProto.hasOwnProperty;
|
||||
|
||||
// All **ECMAScript 5** native function implementations that we hope to use
|
||||
// are declared here.
|
||||
var
|
||||
nativeForEach = ArrayProto.forEach,
|
||||
nativeMap = ArrayProto.map,
|
||||
nativeReduce = ArrayProto.reduce,
|
||||
nativeReduceRight = ArrayProto.reduceRight,
|
||||
nativeFilter = ArrayProto.filter,
|
||||
nativeEvery = ArrayProto.every,
|
||||
nativeSome = ArrayProto.some,
|
||||
nativeIndexOf = ArrayProto.indexOf,
|
||||
nativeLastIndexOf = ArrayProto.lastIndexOf,
|
||||
nativeIsArray = Array.isArray,
|
||||
nativeKeys = Object.keys,
|
||||
nativeBind = FuncProto.bind;
|
||||
|
||||
// Create a safe reference to the Underscore object for use below.
|
||||
var _ = function(obj) { return new wrapper(obj); };
|
||||
|
||||
// Export the Underscore object for **Node.js**, with
|
||||
// backwards-compatibility for the old `require()` API. If we're in
|
||||
// the browser, add `_` as a global object via a string identifier,
|
||||
// for Closure Compiler "advanced" mode.
|
||||
if (typeof exports !== 'undefined') {
|
||||
if (typeof module !== 'undefined' && module.exports) {
|
||||
exports = module.exports = _;
|
||||
}
|
||||
exports._ = _;
|
||||
} else {
|
||||
root['_'] = _;
|
||||
}
|
||||
|
||||
// Current version.
|
||||
_.VERSION = '1.3.1';
|
||||
|
||||
// Collection Functions
|
||||
// --------------------
|
||||
|
||||
// The cornerstone, an `each` implementation, aka `forEach`.
|
||||
// Handles objects with the built-in `forEach`, arrays, and raw objects.
|
||||
// Delegates to **ECMAScript 5**'s native `forEach` if available.
|
||||
var each = _.each = _.forEach = function(obj, iterator, context) {
|
||||
if (obj == null) return;
|
||||
if (nativeForEach && obj.forEach === nativeForEach) {
|
||||
obj.forEach(iterator, context);
|
||||
} else if (obj.length === +obj.length) {
|
||||
for (var i = 0, l = obj.length; i < l; i++) {
|
||||
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
|
||||
}
|
||||
} else {
|
||||
for (var key in obj) {
|
||||
if (_.has(obj, key)) {
|
||||
if (iterator.call(context, obj[key], key, obj) === breaker) return;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Return the results of applying the iterator to each element.
|
||||
// Delegates to **ECMAScript 5**'s native `map` if available.
|
||||
_.map = _.collect = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
results[results.length] = iterator.call(context, value, index, list);
|
||||
});
|
||||
if (obj.length === +obj.length) results.length = obj.length;
|
||||
return results;
|
||||
};
|
||||
|
||||
// **Reduce** builds up a single result from a list of values, aka `inject`,
|
||||
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
|
||||
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduce && obj.reduce === nativeReduce) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
|
||||
}
|
||||
each(obj, function(value, index, list) {
|
||||
if (!initial) {
|
||||
memo = value;
|
||||
initial = true;
|
||||
} else {
|
||||
memo = iterator.call(context, memo, value, index, list);
|
||||
}
|
||||
});
|
||||
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
|
||||
return memo;
|
||||
};
|
||||
|
||||
// The right-associative version of reduce, also known as `foldr`.
|
||||
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
|
||||
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
|
||||
}
|
||||
var reversed = _.toArray(obj).reverse();
|
||||
if (context && !initial) iterator = _.bind(iterator, context);
|
||||
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
|
||||
};
|
||||
|
||||
// Return the first value which passes a truth test. Aliased as `detect`.
|
||||
_.find = _.detect = function(obj, iterator, context) {
|
||||
var result;
|
||||
any(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) {
|
||||
result = value;
|
||||
return true;
|
||||
}
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Return all the elements that pass a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `filter` if available.
|
||||
// Aliased as `select`.
|
||||
_.filter = _.select = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Return all the elements for which a truth test fails.
|
||||
_.reject = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
each(obj, function(value, index, list) {
|
||||
if (!iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Determine whether all of the elements match a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `every` if available.
|
||||
// Aliased as `all`.
|
||||
_.every = _.all = function(obj, iterator, context) {
|
||||
var result = true;
|
||||
if (obj == null) return result;
|
||||
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Determine if at least one element in the object matches a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `some` if available.
|
||||
// Aliased as `any`.
|
||||
var any = _.some = _.any = function(obj, iterator, context) {
|
||||
iterator || (iterator = _.identity);
|
||||
var result = false;
|
||||
if (obj == null) return result;
|
||||
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (result || (result = iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return !!result;
|
||||
};
|
||||
|
||||
// Determine if a given value is included in the array or object using `===`.
|
||||
// Aliased as `contains`.
|
||||
_.include = _.contains = function(obj, target) {
|
||||
var found = false;
|
||||
if (obj == null) return found;
|
||||
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
|
||||
found = any(obj, function(value) {
|
||||
return value === target;
|
||||
});
|
||||
return found;
|
||||
};
|
||||
|
||||
// Invoke a method (with arguments) on every item in a collection.
|
||||
_.invoke = function(obj, method) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return _.map(obj, function(value) {
|
||||
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
|
||||
});
|
||||
};
|
||||
|
||||
// Convenience version of a common use case of `map`: fetching a property.
|
||||
_.pluck = function(obj, key) {
|
||||
return _.map(obj, function(value){ return value[key]; });
|
||||
};
|
||||
|
||||
// Return the maximum element or (element-based computation).
|
||||
_.max = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return -Infinity;
|
||||
var result = {computed : -Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed >= result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Return the minimum element (or element-based computation).
|
||||
_.min = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return Infinity;
|
||||
var result = {computed : Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed < result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Shuffle an array.
|
||||
_.shuffle = function(obj) {
|
||||
var shuffled = [], rand;
|
||||
each(obj, function(value, index, list) {
|
||||
if (index == 0) {
|
||||
shuffled[0] = value;
|
||||
} else {
|
||||
rand = Math.floor(Math.random() * (index + 1));
|
||||
shuffled[index] = shuffled[rand];
|
||||
shuffled[rand] = value;
|
||||
}
|
||||
});
|
||||
return shuffled;
|
||||
};
|
||||
|
||||
// Sort the object's values by a criterion produced by an iterator.
|
||||
_.sortBy = function(obj, iterator, context) {
|
||||
return _.pluck(_.map(obj, function(value, index, list) {
|
||||
return {
|
||||
value : value,
|
||||
criteria : iterator.call(context, value, index, list)
|
||||
};
|
||||
}).sort(function(left, right) {
|
||||
var a = left.criteria, b = right.criteria;
|
||||
return a < b ? -1 : a > b ? 1 : 0;
|
||||
}), 'value');
|
||||
};
|
||||
|
||||
// Groups the object's values by a criterion. Pass either a string attribute
|
||||
// to group by, or a function that returns the criterion.
|
||||
_.groupBy = function(obj, val) {
|
||||
var result = {};
|
||||
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
|
||||
each(obj, function(value, index) {
|
||||
var key = iterator(value, index);
|
||||
(result[key] || (result[key] = [])).push(value);
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Use a comparator function to figure out at what index an object should
|
||||
// be inserted so as to maintain order. Uses binary search.
|
||||
_.sortedIndex = function(array, obj, iterator) {
|
||||
iterator || (iterator = _.identity);
|
||||
var low = 0, high = array.length;
|
||||
while (low < high) {
|
||||
var mid = (low + high) >> 1;
|
||||
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
|
||||
}
|
||||
return low;
|
||||
};
|
||||
|
||||
// Safely convert anything iterable into a real, live array.
|
||||
_.toArray = function(iterable) {
|
||||
if (!iterable) return [];
|
||||
if (iterable.toArray) return iterable.toArray();
|
||||
if (_.isArray(iterable)) return slice.call(iterable);
|
||||
if (_.isArguments(iterable)) return slice.call(iterable);
|
||||
return _.values(iterable);
|
||||
};
|
||||
|
||||
// Return the number of elements in an object.
|
||||
_.size = function(obj) {
|
||||
return _.toArray(obj).length;
|
||||
};
|
||||
|
||||
// Array Functions
|
||||
// ---------------
|
||||
|
||||
// Get the first element of an array. Passing **n** will return the first N
|
||||
// values in the array. Aliased as `head`. The **guard** check allows it to work
|
||||
// with `_.map`.
|
||||
_.first = _.head = function(array, n, guard) {
|
||||
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
|
||||
};
|
||||
|
||||
// Returns everything but the last entry of the array. Especcialy useful on
|
||||
// the arguments object. Passing **n** will return all the values in
|
||||
// the array, excluding the last N. The **guard** check allows it to work with
|
||||
// `_.map`.
|
||||
_.initial = function(array, n, guard) {
|
||||
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
|
||||
};
|
||||
|
||||
// Get the last element of an array. Passing **n** will return the last N
|
||||
// values in the array. The **guard** check allows it to work with `_.map`.
|
||||
_.last = function(array, n, guard) {
|
||||
if ((n != null) && !guard) {
|
||||
return slice.call(array, Math.max(array.length - n, 0));
|
||||
} else {
|
||||
return array[array.length - 1];
|
||||
}
|
||||
};
|
||||
|
||||
// Returns everything but the first entry of the array. Aliased as `tail`.
|
||||
// Especially useful on the arguments object. Passing an **index** will return
|
||||
// the rest of the values in the array from that index onward. The **guard**
|
||||
// check allows it to work with `_.map`.
|
||||
_.rest = _.tail = function(array, index, guard) {
|
||||
return slice.call(array, (index == null) || guard ? 1 : index);
|
||||
};
|
||||
|
||||
// Trim out all falsy values from an array.
|
||||
_.compact = function(array) {
|
||||
return _.filter(array, function(value){ return !!value; });
|
||||
};
|
||||
|
||||
// Return a completely flattened version of an array.
|
||||
_.flatten = function(array, shallow) {
|
||||
return _.reduce(array, function(memo, value) {
|
||||
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
|
||||
memo[memo.length] = value;
|
||||
return memo;
|
||||
}, []);
|
||||
};
|
||||
|
||||
// Return a version of the array that does not contain the specified value(s).
|
||||
_.without = function(array) {
|
||||
return _.difference(array, slice.call(arguments, 1));
|
||||
};
|
||||
|
||||
// Produce a duplicate-free version of the array. If the array has already
|
||||
// been sorted, you have the option of using a faster algorithm.
|
||||
// Aliased as `unique`.
|
||||
_.uniq = _.unique = function(array, isSorted, iterator) {
|
||||
var initial = iterator ? _.map(array, iterator) : array;
|
||||
var result = [];
|
||||
_.reduce(initial, function(memo, el, i) {
|
||||
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
|
||||
memo[memo.length] = el;
|
||||
result[result.length] = array[i];
|
||||
}
|
||||
return memo;
|
||||
}, []);
|
||||
return result;
|
||||
};
|
||||
|
||||
// Produce an array that contains the union: each distinct element from all of
|
||||
// the passed-in arrays.
|
||||
_.union = function() {
|
||||
return _.uniq(_.flatten(arguments, true));
|
||||
};
|
||||
|
||||
// Produce an array that contains every item shared between all the
|
||||
// passed-in arrays. (Aliased as "intersect" for back-compat.)
|
||||
_.intersection = _.intersect = function(array) {
|
||||
var rest = slice.call(arguments, 1);
|
||||
return _.filter(_.uniq(array), function(item) {
|
||||
return _.every(rest, function(other) {
|
||||
return _.indexOf(other, item) >= 0;
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
// Take the difference between one array and a number of other arrays.
|
||||
// Only the elements present in just the first array will remain.
|
||||
_.difference = function(array) {
|
||||
var rest = _.flatten(slice.call(arguments, 1));
|
||||
return _.filter(array, function(value){ return !_.include(rest, value); });
|
||||
};
|
||||
|
||||
// Zip together multiple lists into a single array -- elements that share
|
||||
// an index go together.
|
||||
_.zip = function() {
|
||||
var args = slice.call(arguments);
|
||||
var length = _.max(_.pluck(args, 'length'));
|
||||
var results = new Array(length);
|
||||
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
|
||||
return results;
|
||||
};
|
||||
|
||||
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
|
||||
// we need this function. Return the position of the first occurrence of an
|
||||
// item in an array, or -1 if the item is not included in the array.
|
||||
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
|
||||
// If the array is large and already in sort order, pass `true`
|
||||
// for **isSorted** to use binary search.
|
||||
_.indexOf = function(array, item, isSorted) {
|
||||
if (array == null) return -1;
|
||||
var i, l;
|
||||
if (isSorted) {
|
||||
i = _.sortedIndex(array, item);
|
||||
return array[i] === item ? i : -1;
|
||||
}
|
||||
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
|
||||
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
|
||||
_.lastIndexOf = function(array, item) {
|
||||
if (array == null) return -1;
|
||||
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
|
||||
var i = array.length;
|
||||
while (i--) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Generate an integer Array containing an arithmetic progression. A port of
|
||||
// the native Python `range()` function. See
|
||||
// [the Python documentation](http://docs.python.org/library/functions.html#range).
|
||||
_.range = function(start, stop, step) {
|
||||
if (arguments.length <= 1) {
|
||||
stop = start || 0;
|
||||
start = 0;
|
||||
}
|
||||
step = arguments[2] || 1;
|
||||
|
||||
var len = Math.max(Math.ceil((stop - start) / step), 0);
|
||||
var idx = 0;
|
||||
var range = new Array(len);
|
||||
|
||||
while(idx < len) {
|
||||
range[idx++] = start;
|
||||
start += step;
|
||||
}
|
||||
|
||||
return range;
|
||||
};
|
||||
|
||||
// Function (ahem) Functions
|
||||
// ------------------
|
||||
|
||||
// Reusable constructor function for prototype setting.
|
||||
var ctor = function(){};
|
||||
|
||||
// Create a function bound to a given object (assigning `this`, and arguments,
|
||||
// optionally). Binding with arguments is also known as `curry`.
|
||||
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
|
||||
// We check for `func.bind` first, to fail fast when `func` is undefined.
|
||||
_.bind = function bind(func, context) {
|
||||
var bound, args;
|
||||
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
|
||||
if (!_.isFunction(func)) throw new TypeError;
|
||||
args = slice.call(arguments, 2);
|
||||
return bound = function() {
|
||||
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
|
||||
ctor.prototype = func.prototype;
|
||||
var self = new ctor;
|
||||
var result = func.apply(self, args.concat(slice.call(arguments)));
|
||||
if (Object(result) === result) return result;
|
||||
return self;
|
||||
};
|
||||
};
|
||||
|
||||
// Bind all of an object's methods to that object. Useful for ensuring that
|
||||
// all callbacks defined on an object belong to it.
|
||||
_.bindAll = function(obj) {
|
||||
var funcs = slice.call(arguments, 1);
|
||||
if (funcs.length == 0) funcs = _.functions(obj);
|
||||
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Memoize an expensive function by storing its results.
|
||||
_.memoize = function(func, hasher) {
|
||||
var memo = {};
|
||||
hasher || (hasher = _.identity);
|
||||
return function() {
|
||||
var key = hasher.apply(this, arguments);
|
||||
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
|
||||
};
|
||||
};
|
||||
|
||||
// Delays a function for the given number of milliseconds, and then calls
|
||||
// it with the arguments supplied.
|
||||
_.delay = function(func, wait) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return setTimeout(function(){ return func.apply(func, args); }, wait);
|
||||
};
|
||||
|
||||
// Defers a function, scheduling it to run after the current call stack has
|
||||
// cleared.
|
||||
_.defer = function(func) {
|
||||
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
|
||||
};
|
||||
|
||||
// Returns a function, that, when invoked, will only be triggered at most once
|
||||
// during a given window of time.
|
||||
_.throttle = function(func, wait) {
|
||||
var context, args, timeout, throttling, more;
|
||||
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
|
||||
return function() {
|
||||
context = this; args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
if (more) func.apply(context, args);
|
||||
whenDone();
|
||||
};
|
||||
if (!timeout) timeout = setTimeout(later, wait);
|
||||
if (throttling) {
|
||||
more = true;
|
||||
} else {
|
||||
func.apply(context, args);
|
||||
}
|
||||
whenDone();
|
||||
throttling = true;
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function, that, as long as it continues to be invoked, will not
|
||||
// be triggered. The function will be called after it stops being called for
|
||||
// N milliseconds.
|
||||
_.debounce = function(func, wait) {
|
||||
var timeout;
|
||||
return function() {
|
||||
var context = this, args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
func.apply(context, args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will be executed at most one time, no matter how
|
||||
// often you call it. Useful for lazy initialization.
|
||||
_.once = function(func) {
|
||||
var ran = false, memo;
|
||||
return function() {
|
||||
if (ran) return memo;
|
||||
ran = true;
|
||||
return memo = func.apply(this, arguments);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns the first function passed as an argument to the second,
|
||||
// allowing you to adjust arguments, run code before and after, and
|
||||
// conditionally execute the original function.
|
||||
_.wrap = function(func, wrapper) {
|
||||
return function() {
|
||||
var args = [func].concat(slice.call(arguments, 0));
|
||||
return wrapper.apply(this, args);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that is the composition of a list of functions, each
|
||||
// consuming the return value of the function that follows.
|
||||
_.compose = function() {
|
||||
var funcs = arguments;
|
||||
return function() {
|
||||
var args = arguments;
|
||||
for (var i = funcs.length - 1; i >= 0; i--) {
|
||||
args = [funcs[i].apply(this, args)];
|
||||
}
|
||||
return args[0];
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will only be executed after being called N times.
|
||||
_.after = function(times, func) {
|
||||
if (times <= 0) return func();
|
||||
return function() {
|
||||
if (--times < 1) { return func.apply(this, arguments); }
|
||||
};
|
||||
};
|
||||
|
||||
// Object Functions
|
||||
// ----------------
|
||||
|
||||
// Retrieve the names of an object's properties.
|
||||
// Delegates to **ECMAScript 5**'s native `Object.keys`
|
||||
_.keys = nativeKeys || function(obj) {
|
||||
if (obj !== Object(obj)) throw new TypeError('Invalid object');
|
||||
var keys = [];
|
||||
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
|
||||
return keys;
|
||||
};
|
||||
|
||||
// Retrieve the values of an object's properties.
|
||||
_.values = function(obj) {
|
||||
return _.map(obj, _.identity);
|
||||
};
|
||||
|
||||
// Return a sorted list of the function names available on the object.
|
||||
// Aliased as `methods`
|
||||
_.functions = _.methods = function(obj) {
|
||||
var names = [];
|
||||
for (var key in obj) {
|
||||
if (_.isFunction(obj[key])) names.push(key);
|
||||
}
|
||||
return names.sort();
|
||||
};
|
||||
|
||||
// Extend a given object with all the properties in passed-in object(s).
|
||||
_.extend = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Fill in a given object with default properties.
|
||||
_.defaults = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
if (obj[prop] == null) obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Create a (shallow-cloned) duplicate of an object.
|
||||
_.clone = function(obj) {
|
||||
if (!_.isObject(obj)) return obj;
|
||||
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
|
||||
};
|
||||
|
||||
// Invokes interceptor with the obj, and then returns obj.
|
||||
// The primary purpose of this method is to "tap into" a method chain, in
|
||||
// order to perform operations on intermediate results within the chain.
|
||||
_.tap = function(obj, interceptor) {
|
||||
interceptor(obj);
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Internal recursive comparison function.
|
||||
function eq(a, b, stack) {
|
||||
// Identical objects are equal. `0 === -0`, but they aren't identical.
|
||||
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
|
||||
if (a === b) return a !== 0 || 1 / a == 1 / b;
|
||||
// A strict comparison is necessary because `null == undefined`.
|
||||
if (a == null || b == null) return a === b;
|
||||
// Unwrap any wrapped objects.
|
||||
if (a._chain) a = a._wrapped;
|
||||
if (b._chain) b = b._wrapped;
|
||||
// Invoke a custom `isEqual` method if one is provided.
|
||||
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
|
||||
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
|
||||
// Compare `[[Class]]` names.
|
||||
var className = toString.call(a);
|
||||
if (className != toString.call(b)) return false;
|
||||
switch (className) {
|
||||
// Strings, numbers, dates, and booleans are compared by value.
|
||||
case '[object String]':
|
||||
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
|
||||
// equivalent to `new String("5")`.
|
||||
return a == String(b);
|
||||
case '[object Number]':
|
||||
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
|
||||
// other numeric values.
|
||||
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
|
||||
case '[object Date]':
|
||||
case '[object Boolean]':
|
||||
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
|
||||
// millisecond representations. Note that invalid dates with millisecond representations
|
||||
// of `NaN` are not equivalent.
|
||||
return +a == +b;
|
||||
// RegExps are compared by their source patterns and flags.
|
||||
case '[object RegExp]':
|
||||
return a.source == b.source &&
|
||||
a.global == b.global &&
|
||||
a.multiline == b.multiline &&
|
||||
a.ignoreCase == b.ignoreCase;
|
||||
}
|
||||
if (typeof a != 'object' || typeof b != 'object') return false;
|
||||
// Assume equality for cyclic structures. The algorithm for detecting cyclic
|
||||
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
|
||||
var length = stack.length;
|
||||
while (length--) {
|
||||
// Linear search. Performance is inversely proportional to the number of
|
||||
// unique nested structures.
|
||||
if (stack[length] == a) return true;
|
||||
}
|
||||
// Add the first object to the stack of traversed objects.
|
||||
stack.push(a);
|
||||
var size = 0, result = true;
|
||||
// Recursively compare objects and arrays.
|
||||
if (className == '[object Array]') {
|
||||
// Compare array lengths to determine if a deep comparison is necessary.
|
||||
size = a.length;
|
||||
result = size == b.length;
|
||||
if (result) {
|
||||
// Deep compare the contents, ignoring non-numeric properties.
|
||||
while (size--) {
|
||||
// Ensure commutative equality for sparse arrays.
|
||||
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Objects with different constructors are not equivalent.
|
||||
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
|
||||
// Deep compare objects.
|
||||
for (var key in a) {
|
||||
if (_.has(a, key)) {
|
||||
// Count the expected number of properties.
|
||||
size++;
|
||||
// Deep compare each member.
|
||||
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
|
||||
}
|
||||
}
|
||||
// Ensure that both objects contain the same number of properties.
|
||||
if (result) {
|
||||
for (key in b) {
|
||||
if (_.has(b, key) && !(size--)) break;
|
||||
}
|
||||
result = !size;
|
||||
}
|
||||
}
|
||||
// Remove the first object from the stack of traversed objects.
|
||||
stack.pop();
|
||||
return result;
|
||||
}
|
||||
|
||||
// Perform a deep comparison to check if two objects are equal.
|
||||
_.isEqual = function(a, b) {
|
||||
return eq(a, b, []);
|
||||
};
|
||||
|
||||
// Is a given array, string, or object empty?
|
||||
// An "empty" object has no enumerable own-properties.
|
||||
_.isEmpty = function(obj) {
|
||||
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
|
||||
for (var key in obj) if (_.has(obj, key)) return false;
|
||||
return true;
|
||||
};
|
||||
|
||||
// Is a given value a DOM element?
|
||||
_.isElement = function(obj) {
|
||||
return !!(obj && obj.nodeType == 1);
|
||||
};
|
||||
|
||||
// Is a given value an array?
|
||||
// Delegates to ECMA5's native Array.isArray
|
||||
_.isArray = nativeIsArray || function(obj) {
|
||||
return toString.call(obj) == '[object Array]';
|
||||
};
|
||||
|
||||
// Is a given variable an object?
|
||||
_.isObject = function(obj) {
|
||||
return obj === Object(obj);
|
||||
};
|
||||
|
||||
// Is a given variable an arguments object?
|
||||
_.isArguments = function(obj) {
|
||||
return toString.call(obj) == '[object Arguments]';
|
||||
};
|
||||
if (!_.isArguments(arguments)) {
|
||||
_.isArguments = function(obj) {
|
||||
return !!(obj && _.has(obj, 'callee'));
|
||||
};
|
||||
}
|
||||
|
||||
// Is a given value a function?
|
||||
_.isFunction = function(obj) {
|
||||
return toString.call(obj) == '[object Function]';
|
||||
};
|
||||
|
||||
// Is a given value a string?
|
||||
_.isString = function(obj) {
|
||||
return toString.call(obj) == '[object String]';
|
||||
};
|
||||
|
||||
// Is a given value a number?
|
||||
_.isNumber = function(obj) {
|
||||
return toString.call(obj) == '[object Number]';
|
||||
};
|
||||
|
||||
// Is the given value `NaN`?
|
||||
_.isNaN = function(obj) {
|
||||
// `NaN` is the only value for which `===` is not reflexive.
|
||||
return obj !== obj;
|
||||
};
|
||||
|
||||
// Is a given value a boolean?
|
||||
_.isBoolean = function(obj) {
|
||||
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
|
||||
};
|
||||
|
||||
// Is a given value a date?
|
||||
_.isDate = function(obj) {
|
||||
return toString.call(obj) == '[object Date]';
|
||||
};
|
||||
|
||||
// Is the given value a regular expression?
|
||||
_.isRegExp = function(obj) {
|
||||
return toString.call(obj) == '[object RegExp]';
|
||||
};
|
||||
|
||||
// Is a given value equal to null?
|
||||
_.isNull = function(obj) {
|
||||
return obj === null;
|
||||
};
|
||||
|
||||
// Is a given variable undefined?
|
||||
_.isUndefined = function(obj) {
|
||||
return obj === void 0;
|
||||
};
|
||||
|
||||
// Has own property?
|
||||
_.has = function(obj, key) {
|
||||
return hasOwnProperty.call(obj, key);
|
||||
};
|
||||
|
||||
// Utility Functions
|
||||
// -----------------
|
||||
|
||||
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
|
||||
// previous owner. Returns a reference to the Underscore object.
|
||||
_.noConflict = function() {
|
||||
root._ = previousUnderscore;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Keep the identity function around for default iterators.
|
||||
_.identity = function(value) {
|
||||
return value;
|
||||
};
|
||||
|
||||
// Run a function **n** times.
|
||||
_.times = function (n, iterator, context) {
|
||||
for (var i = 0; i < n; i++) iterator.call(context, i);
|
||||
};
|
||||
|
||||
// Escape a string for HTML interpolation.
|
||||
_.escape = function(string) {
|
||||
return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
|
||||
};
|
||||
|
||||
// Add your own custom functions to the Underscore object, ensuring that
|
||||
// they're correctly added to the OOP wrapper as well.
|
||||
_.mixin = function(obj) {
|
||||
each(_.functions(obj), function(name){
|
||||
addToWrapper(name, _[name] = obj[name]);
|
||||
});
|
||||
};
|
||||
|
||||
// Generate a unique integer id (unique within the entire client session).
|
||||
// Useful for temporary DOM ids.
|
||||
var idCounter = 0;
|
||||
_.uniqueId = function(prefix) {
|
||||
var id = idCounter++;
|
||||
return prefix ? prefix + id : id;
|
||||
};
|
||||
|
||||
// By default, Underscore uses ERB-style template delimiters, change the
|
||||
// following template settings to use alternative delimiters.
|
||||
_.templateSettings = {
|
||||
evaluate : /<%([\s\S]+?)%>/g,
|
||||
interpolate : /<%=([\s\S]+?)%>/g,
|
||||
escape : /<%-([\s\S]+?)%>/g
|
||||
};
|
||||
|
||||
// When customizing `templateSettings`, if you don't want to define an
|
||||
// interpolation, evaluation or escaping regex, we need one that is
|
||||
// guaranteed not to match.
|
||||
var noMatch = /.^/;
|
||||
|
||||
// Within an interpolation, evaluation, or escaping, remove HTML escaping
|
||||
// that had been previously added.
|
||||
var unescape = function(code) {
|
||||
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
|
||||
};
|
||||
|
||||
// JavaScript micro-templating, similar to John Resig's implementation.
|
||||
// Underscore templating handles arbitrary delimiters, preserves whitespace,
|
||||
// and correctly escapes quotes within interpolated code.
|
||||
_.template = function(str, data) {
|
||||
var c = _.templateSettings;
|
||||
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
|
||||
'with(obj||{}){__p.push(\'' +
|
||||
str.replace(/\\/g, '\\\\')
|
||||
.replace(/'/g, "\\'")
|
||||
.replace(c.escape || noMatch, function(match, code) {
|
||||
return "',_.escape(" + unescape(code) + "),'";
|
||||
})
|
||||
.replace(c.interpolate || noMatch, function(match, code) {
|
||||
return "'," + unescape(code) + ",'";
|
||||
})
|
||||
.replace(c.evaluate || noMatch, function(match, code) {
|
||||
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
|
||||
})
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\t/g, '\\t')
|
||||
+ "');}return __p.join('');";
|
||||
var func = new Function('obj', '_', tmpl);
|
||||
if (data) return func(data, _);
|
||||
return function(data) {
|
||||
return func.call(this, data, _);
|
||||
};
|
||||
};
|
||||
|
||||
// Add a "chain" function, which will delegate to the wrapper.
|
||||
_.chain = function(obj) {
|
||||
return _(obj).chain();
|
||||
};
|
||||
|
||||
// The OOP Wrapper
|
||||
// ---------------
|
||||
|
||||
// If Underscore is called as a function, it returns a wrapped object that
|
||||
// can be used OO-style. This wrapper holds altered versions of all the
|
||||
// underscore functions. Wrapped objects may be chained.
|
||||
var wrapper = function(obj) { this._wrapped = obj; };
|
||||
|
||||
// Expose `wrapper.prototype` as `_.prototype`
|
||||
_.prototype = wrapper.prototype;
|
||||
|
||||
// Helper function to continue chaining intermediate results.
|
||||
var result = function(obj, chain) {
|
||||
return chain ? _(obj).chain() : obj;
|
||||
};
|
||||
|
||||
// A method to easily add functions to the OOP wrapper.
|
||||
var addToWrapper = function(name, func) {
|
||||
wrapper.prototype[name] = function() {
|
||||
var args = slice.call(arguments);
|
||||
unshift.call(args, this._wrapped);
|
||||
return result(func.apply(_, args), this._chain);
|
||||
};
|
||||
};
|
||||
|
||||
// Add all of the Underscore functions to the wrapper object.
|
||||
_.mixin(_);
|
||||
|
||||
// Add all mutator Array functions to the wrapper.
|
||||
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
var wrapped = this._wrapped;
|
||||
method.apply(wrapped, arguments);
|
||||
var length = wrapped.length;
|
||||
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
|
||||
return result(wrapped, this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Add all accessor Array functions to the wrapper.
|
||||
each(['concat', 'join', 'slice'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
return result(method.apply(this._wrapped, arguments), this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Start chaining a wrapped Underscore object.
|
||||
wrapper.prototype.chain = function() {
|
||||
this._chain = true;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Extracts the result from a wrapped and chained object.
|
||||
wrapper.prototype.value = function() {
|
||||
return this._wrapped;
|
||||
};
|
||||
|
||||
}).call(this);
|
File diff suppressed because one or more lines are too long
@ -177,31 +177,31 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.networking.html">com.vmware.appliance.networking package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#com-vmware-appliance-networking-dns-client-module">com.vmware.appliance.networking.dns_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#com-vmware-appliance-networking-firewall-client-module">com.vmware.appliance.networking.firewall_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#com-vmware-appliance-networking-interfaces-client-module">com.vmware.appliance.networking.interfaces_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.dns_client">com.vmware.appliance.networking.dns_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.firewall_client">com.vmware.appliance.networking.firewall_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.interfaces_client">com.vmware.appliance.networking.interfaces_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.recovery.html">com.vmware.appliance.recovery package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html">com.vmware.appliance.recovery.backup package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#com-vmware-appliance-recovery-backup-job-client-module">com.vmware.appliance.recovery.backup.job_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#com-vmware-appliance-recovery-backup-system-name-client-module">com.vmware.appliance.recovery.backup.system_name_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.job_client">com.vmware.appliance.recovery.backup.job_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.system_name_client">com.vmware.appliance.recovery.backup.system_name_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.html#com-vmware-appliance-recovery-backup-client-module">com.vmware.appliance.recovery.backup_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.html#com-vmware-appliance-recovery-reconciliation-client-module">com.vmware.appliance.recovery.reconciliation_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.html#com-vmware-appliance-recovery-restore-client-module">com.vmware.appliance.recovery.restore_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.backup_client">com.vmware.appliance.recovery.backup_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.reconciliation_client">com.vmware.appliance.recovery.reconciliation_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.restore_client">com.vmware.appliance.recovery.restore_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.system.html">com.vmware.appliance.system package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.system.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.system.html#com-vmware-appliance-system-security-client-module">com.vmware.appliance.system.security_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.system.html#com-vmware-appliance-system-time-client-module">com.vmware.appliance.system.time_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.system.html#module-com.vmware.appliance.system.security_client">com.vmware.appliance.system.security_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.system.html#module-com.vmware.appliance.system.time_client">com.vmware.appliance.system.time_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.vcenter.html">com.vmware.appliance.vcenter package</a><ul>
|
||||
@ -211,13 +211,13 @@
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html">com.vmware.appliance.vcenter.settings.v1 package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#com-vmware-appliance-vcenter-settings-v1-config-client-module">com.vmware.appliance.vcenter.settings.v1.config_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#module-com.vmware.appliance.vcenter.settings.v1.config_client">com.vmware.appliance.vcenter.settings.v1.config_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#com-vmware-appliance-vcenter-settings-v1-client-module">com.vmware.appliance.vcenter.settings.v1_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#module-com.vmware.appliance.vcenter.settings.v1_client">com.vmware.appliance.vcenter.settings.v1_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -227,28 +227,28 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-access-client-module">com.vmware.appliance.access_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-health-client-module">com.vmware.appliance.health_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-infraprofile-client-module">com.vmware.appliance.infraprofile_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-local-accounts-client-module">com.vmware.appliance.local_accounts_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-localaccounts-client-module">com.vmware.appliance.localaccounts_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-logging-client-module">com.vmware.appliance.logging_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-monitoring-client-module">com.vmware.appliance.monitoring_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-networking-client-module">com.vmware.appliance.networking_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-ntp-client-module">com.vmware.appliance.ntp_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-recovery-client-module">com.vmware.appliance.recovery_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-shutdown-client-module">com.vmware.appliance.shutdown_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-support-bundle-client-module">com.vmware.appliance.support_bundle_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-supportbundle-client-module">com.vmware.appliance.supportbundle_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-system-client-module">com.vmware.appliance.system_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-update-client-module">com.vmware.appliance.update_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#com-vmware-appliance-vmon-client-module">com.vmware.appliance.vmon_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.access_client">com.vmware.appliance.access_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.health_client">com.vmware.appliance.health_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.infraprofile_client">com.vmware.appliance.infraprofile_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.local_accounts_client">com.vmware.appliance.local_accounts_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.localaccounts_client">com.vmware.appliance.localaccounts_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.logging_client">com.vmware.appliance.logging_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.monitoring_client">com.vmware.appliance.monitoring_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.networking_client">com.vmware.appliance.networking_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.ntp_client">com.vmware.appliance.ntp_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.recovery_client">com.vmware.appliance.recovery_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.shutdown_client">com.vmware.appliance.shutdown_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.support_bundle_client">com.vmware.appliance.support_bundle_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.supportbundle_client">com.vmware.appliance.supportbundle_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.system_client">com.vmware.appliance.system_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.update_client">com.vmware.appliance.update_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.vmon_client">com.vmware.appliance.vmon_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.cis.html">com.vmware.cis package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.cis.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.cis.html#com-vmware-cis-tagging-client-module">com.vmware.cis.tagging_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.cis.html#com-vmware-cis-task-client-module">com.vmware.cis.task_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.cis.html#module-com.vmware.cis.tagging_client">com.vmware.cis.tagging_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.cis.html#module-com.vmware.cis.task_client">com.vmware.cis.task_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.content.html">com.vmware.content package</a><ul>
|
||||
@ -257,53 +257,53 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.content.library.item.html">com.vmware.content.library.item package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.library.item.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.library.item.html#com-vmware-content-library-item-downloadsession-client-module">com.vmware.content.library.item.downloadsession_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.library.item.html#com-vmware-content-library-item-updatesession-client-module">com.vmware.content.library.item.updatesession_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.downloadsession_client">com.vmware.content.library.item.downloadsession_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.updatesession_client">com.vmware.content.library.item.updatesession_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.html#com-vmware-content-library-item-client-module">com.vmware.content.library.item_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.html#module-com.vmware.content.library.item_client">com.vmware.content.library.item_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.content.type.html">com.vmware.content.type package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.content.type.ovf.html">com.vmware.content.type.ovf package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.type.ovf.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.type.ovf.html#com-vmware-content-type-ovf-policy-client-module">com.vmware.content.type.ovf.policy_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.type.ovf.html#module-com.vmware.content.type.ovf.policy_client">com.vmware.content.type.ovf.policy_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.html#com-vmware-content-type-ovf-client-module">com.vmware.content.type.ovf_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.html#module-com.vmware.content.type.ovf_client">com.vmware.content.type.ovf_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.html#com-vmware-content-library-client-module">com.vmware.content.library_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.html#module-com.vmware.content.library_client">com.vmware.content.library_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.html">com.vmware.esx package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.hcl.html">com.vmware.esx.hcl package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hcl.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hcl.html#com-vmware-esx-hcl-hosts-client-module">com.vmware.esx.hcl.hosts_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hcl.html#module-com.vmware.esx.hcl.hosts_client">com.vmware.esx.hcl.hosts_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.hosts.html">com.vmware.esx.hosts package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hosts.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.hosts.health.html">com.vmware.esx.hosts.health package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.hosts.health.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.hosts.health.html#com-vmware-esx-hosts-health-perspectives-client-module">com.vmware.esx.hosts.health.perspectives_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.hosts.health.html#module-com.vmware.esx.hosts.health.perspectives_client">com.vmware.esx.hosts.health.perspectives_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hosts.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hosts.html#com-vmware-esx-hosts-software-client-module">com.vmware.esx.hosts.software_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hosts.html#module-com.vmware.esx.hosts.software_client">com.vmware.esx.hosts.software_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a><ul>
|
||||
@ -312,23 +312,23 @@
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html">com.vmware.esx.settings.clusters.policies package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com-vmware-esx-settings-clusters-policies-apply-client-module">com.vmware.esx.settings.clusters.policies.apply_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#module-com.vmware.esx.settings.clusters.policies.apply_client">com.vmware.esx.settings.clusters.policies.apply_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html">com.vmware.esx.settings.clusters.software package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com-vmware-esx-settings-clusters-software-drafts-client-module">com.vmware.esx.settings.clusters.software.drafts_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com-vmware-esx-settings-clusters-software-reports-client-module">com.vmware.esx.settings.clusters.software.reports_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.drafts_client">com.vmware.esx.settings.clusters.software.drafts_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.reports_client">com.vmware.esx.settings.clusters.software.reports_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#com-vmware-esx-settings-clusters-configuration-client-module">com.vmware.esx.settings.clusters.configuration_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#com-vmware-esx-settings-clusters-enablement-client-module">com.vmware.esx.settings.clusters.enablement_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#com-vmware-esx-settings-clusters-policies-client-module">com.vmware.esx.settings.clusters.policies_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#com-vmware-esx-settings-clusters-software-client-module">com.vmware.esx.settings.clusters.software_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.configuration_client">com.vmware.esx.settings.clusters.configuration_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.enablement_client">com.vmware.esx.settings.clusters.enablement_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.policies_client">com.vmware.esx.settings.clusters.policies_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.software_client">com.vmware.esx.settings.clusters.software_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.defaults.html">com.vmware.esx.settings.defaults package</a><ul>
|
||||
@ -336,57 +336,57 @@
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html">com.vmware.esx.settings.defaults.clusters package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#com-vmware-esx-settings-defaults-clusters-policies-client-module">com.vmware.esx.settings.defaults.clusters.policies_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#module-com.vmware.esx.settings.defaults.clusters.policies_client">com.vmware.esx.settings.defaults.clusters.policies_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#com-vmware-esx-settings-defaults-clusters-client-module">com.vmware.esx.settings.defaults.clusters_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#module-com.vmware.esx.settings.defaults.clusters_client">com.vmware.esx.settings.defaults.clusters_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html">com.vmware.esx.settings.depot_content package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#com-vmware-esx-settings-depot-content-add-ons-client-module">com.vmware.esx.settings.depot_content.add_ons_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#com-vmware-esx-settings-depot-content-base-images-client-module">com.vmware.esx.settings.depot_content.base_images_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#com-vmware-esx-settings-depot-content-components-client-module">com.vmware.esx.settings.depot_content.components_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.add_ons_client">com.vmware.esx.settings.depot_content.add_ons_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.base_images_client">com.vmware.esx.settings.depot_content.base_images_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.components_client">com.vmware.esx.settings.depot_content.components_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html">com.vmware.esx.settings.hardware_support package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html">com.vmware.esx.settings.hardware_support.managers package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#com-vmware-esx-settings-hardware-support-managers-packages-client-module">com.vmware.esx.settings.hardware_support.managers.packages_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#module-com.vmware.esx.settings.hardware_support.managers.packages_client">com.vmware.esx.settings.hardware_support.managers.packages_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#com-vmware-esx-settings-hardware-support-managers-client-module">com.vmware.esx.settings.hardware_support.managers_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#module-com.vmware.esx.settings.hardware_support.managers_client">com.vmware.esx.settings.hardware_support.managers_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#com-vmware-esx-settings-clusters-client-module">com.vmware.esx.settings.clusters_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#com-vmware-esx-settings-defaults-client-module">com.vmware.esx.settings.defaults_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#com-vmware-esx-settings-depot-content-client-module">com.vmware.esx.settings.depot_content_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#com-vmware-esx-settings-depots-client-module">com.vmware.esx.settings.depots_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#com-vmware-esx-settings-hardware-support-client-module">com.vmware.esx.settings.hardware_support_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#com-vmware-esx-settings-hosts-client-module">com.vmware.esx.settings.hosts_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.clusters_client">com.vmware.esx.settings.clusters_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.defaults_client">com.vmware.esx.settings.defaults_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.depot_content_client">com.vmware.esx.settings.depot_content_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.depots_client">com.vmware.esx.settings.depots_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.hardware_support_client">com.vmware.esx.settings.hardware_support_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.hosts_client">com.vmware.esx.settings.hosts_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.html#com-vmware-esx-hcl-client-module">com.vmware.esx.hcl_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.html#com-vmware-esx-hosts-client-module">com.vmware.esx.hosts_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.html#com-vmware-esx-settings-client-module">com.vmware.esx.settings_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.html#module-com.vmware.esx.hcl_client">com.vmware.esx.hcl_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.html#module-com.vmware.esx.hosts_client">com.vmware.esx.hosts_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.html#module-com.vmware.esx.settings_client">com.vmware.esx.settings_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.oauth2.html">com.vmware.oauth2 package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.oauth2.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.oauth2.html#com-vmware-oauth2-errors-client-module">com.vmware.oauth2.errors_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.oauth2.html#module-com.vmware.oauth2.errors_client">com.vmware.oauth2.errors_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.html">com.vmware.vapi package</a><ul>
|
||||
@ -395,47 +395,47 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html">com.vmware.vapi.metadata.authentication package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#com-vmware-vapi-metadata-authentication-service-client-module">com.vmware.vapi.metadata.authentication.service_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication.service_client">com.vmware.vapi.metadata.authentication.service_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html">com.vmware.vapi.metadata.metamodel package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#com-vmware-vapi-metadata-metamodel-resource-client-module">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#com-vmware-vapi-metadata-metamodel-service-client-module">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.resource_client">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.service_client">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html">com.vmware.vapi.metadata.privilege package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#com-vmware-vapi-metadata-privilege-service-client-module">com.vmware.vapi.metadata.privilege.service_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege.service_client">com.vmware.vapi.metadata.privilege.service_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#com-vmware-vapi-metadata-authentication-client-module">com.vmware.vapi.metadata.authentication_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#com-vmware-vapi-metadata-cli-client-module">com.vmware.vapi.metadata.cli_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#com-vmware-vapi-metadata-metamodel-client-module">com.vmware.vapi.metadata.metamodel_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#com-vmware-vapi-metadata-privilege-client-module">com.vmware.vapi.metadata.privilege_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.authentication_client">com.vmware.vapi.metadata.authentication_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.cli_client">com.vmware.vapi.metadata.cli_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client">com.vmware.vapi.metadata.metamodel_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.std.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.std.html#com-vmware-vapi-std-errors-client-module">com.vmware.vapi.std.errors_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.std.html#com-vmware-vapi-std-interposition-client-module">com.vmware.vapi.std.interposition_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client">com.vmware.vapi.std.errors_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.interposition_client">com.vmware.vapi.std.interposition_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.html#com-vmware-vapi-metadata-client-module">com.vmware.vapi.metadata_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.html#com-vmware-vapi-std-client-module">com.vmware.vapi.std_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi.metadata_client">com.vmware.vapi.metadata_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi.std_client">com.vmware.vapi.std_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.html">com.vmware.vcenter package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html">com.vmware.vcenter.certificate_management package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#com-vmware-vcenter-certificate-management-vcenter-client-module">com.vmware.vcenter.certificate_management.vcenter_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#module-com.vmware.vcenter.certificate_management.vcenter_client">com.vmware.vcenter.certificate_management.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.compute.html">com.vmware.vcenter.compute package</a><ul>
|
||||
@ -445,51 +445,51 @@
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-cluster-scale-in-ignore-vm-capabilities-client-module">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-disable-drs-vmotion-client-module">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-host-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-host-anti-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-vm-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-vm-anti-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#com-vmware-vcenter-compute-policies-capabilities-client-module">com.vmware.vcenter.compute.policies.capabilities_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#module-com.vmware.vcenter.compute.policies.capabilities_client">com.vmware.vcenter.compute.policies.capabilities_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.html#com-vmware-vcenter-compute-policies-client-module">com.vmware.vcenter.compute.policies_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.html#module-com.vmware.vcenter.compute.policies_client">com.vmware.vcenter.compute.policies_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.content.html">com.vmware.vcenter.content package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.content.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.content.registries.html">com.vmware.vcenter.content.registries package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#com-vmware-vcenter-content-registries-harbor-client-module">com.vmware.vcenter.content.registries.harbor_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#module-com.vmware.vcenter.content.registries.harbor_client">com.vmware.vcenter.content.registries.harbor_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.content.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.content.html#com-vmware-vcenter-content-registries-client-module">com.vmware.vcenter.content.registries_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.content.html#module-com.vmware.vcenter.content.registries_client">com.vmware.vcenter.content.registries_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html">com.vmware.vcenter.crypto_manager package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html">com.vmware.vcenter.crypto_manager.hosts package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#com-vmware-vcenter-crypto-manager-hosts-kms-client-module">com.vmware.vcenter.crypto_manager.hosts.kms_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#module-com.vmware.vcenter.crypto_manager.hosts.kms_client">com.vmware.vcenter.crypto_manager.hosts.kms_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#com-vmware-vcenter-crypto-manager-hosts-client-module">com.vmware.vcenter.crypto_manager.hosts_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#com-vmware-vcenter-crypto-manager-kms-client-module">com.vmware.vcenter.crypto_manager.kms_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#module-com.vmware.vcenter.crypto_manager.hosts_client">com.vmware.vcenter.crypto_manager.hosts_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#module-com.vmware.vcenter.crypto_manager.kms_client">com.vmware.vcenter.crypto_manager.kms_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.deployment.html">com.vmware.vcenter.deployment package</a><ul>
|
||||
@ -498,73 +498,73 @@
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html">com.vmware.vcenter.deployment.install.initial_config package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#com-vmware-vcenter-deployment-install-initial-config-remote-psc-client-module">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#module-com.vmware.vcenter.deployment.install.initial_config.remote_psc_client">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#com-vmware-vcenter-deployment-install-psc-client-module">com.vmware.vcenter.deployment.install.psc_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#module-com.vmware.vcenter.deployment.install.psc_client">com.vmware.vcenter.deployment.install.psc_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.html#com-vmware-vcenter-deployment-install-client-module">com.vmware.vcenter.deployment.install_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.html#com-vmware-vcenter-deployment-migrate-client-module">com.vmware.vcenter.deployment.migrate_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.install_client">com.vmware.vcenter.deployment.install_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.migrate_client">com.vmware.vcenter.deployment.migrate_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.hvc.html">com.vmware.vcenter.hvc package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html">com.vmware.vcenter.hvc.links package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#com-vmware-vcenter-hvc-links-sync-client-module">com.vmware.vcenter.hvc.links.sync_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links.sync_client">com.vmware.vcenter.hvc.links.sync_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.html#com-vmware-vcenter-hvc-links-client-module">com.vmware.vcenter.hvc.links_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.html#com-vmware-vcenter-hvc-management-client-module">com.vmware.vcenter.hvc.management_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.links_client">com.vmware.vcenter.hvc.links_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.management_client">com.vmware.vcenter.hvc.management_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.lcm.html">com.vmware.vcenter.lcm package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.lcm.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.lcm.html#com-vmware-vcenter-lcm-common-client-module">com.vmware.vcenter.lcm.common_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.lcm.html#com-vmware-vcenter-lcm-discovery-client-module">com.vmware.vcenter.lcm.discovery_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.lcm.html#com-vmware-vcenter-lcm-update-client-module">com.vmware.vcenter.lcm.update_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.lcm.html#module-com.vmware.vcenter.lcm.common_client">com.vmware.vcenter.lcm.common_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.lcm.html#module-com.vmware.vcenter.lcm.discovery_client">com.vmware.vcenter.lcm.discovery_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.lcm.html#module-com.vmware.vcenter.lcm.update_client">com.vmware.vcenter.lcm.update_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html">com.vmware.vcenter.namespace_management package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com-vmware-vcenter-namespace-management-cns-client-module">com.vmware.vcenter.namespace_management.cns_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com-vmware-vcenter-namespace-management-software-client-module">com.vmware.vcenter.namespace_management.software_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com-vmware-vcenter-namespace-management-stats-client-module">com.vmware.vcenter.namespace_management.stats_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.cns_client">com.vmware.vcenter.namespace_management.cns_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.software_client">com.vmware.vcenter.namespace_management.software_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.stats_client">com.vmware.vcenter.namespace_management.stats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespaces.html">com.vmware.vcenter.namespaces package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespaces.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespaces.html#com-vmware-vcenter-namespaces-user-client-module">com.vmware.vcenter.namespaces.user_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespaces.html#module-com.vmware.vcenter.namespaces.user_client">com.vmware.vcenter.namespaces.user_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.storage.html">com.vmware.vcenter.storage package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html">com.vmware.vcenter.storage.policies package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#com-vmware-vcenter-storage-policies-compliance-client-module">com.vmware.vcenter.storage.policies.compliance_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#module-com.vmware.vcenter.storage.policies.compliance_client">com.vmware.vcenter.storage.policies.compliance_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.html#com-vmware-vcenter-storage-policies-client-module">com.vmware.vcenter.storage.policies_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage.policies_client">com.vmware.vcenter.storage.policies_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.system_config.html">com.vmware.vcenter.system_config package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.system_config.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html">com.vmware.vcenter.system_config.features package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#com-vmware-vcenter-system-config-features-tech-preview-client-module">com.vmware.vcenter.system_config.features.tech_preview_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features.tech_preview_client">com.vmware.vcenter.system_config.features.tech_preview_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -578,118 +578,118 @@
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-attestation-tpm2-client-module">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-kms-providers-client-module">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-attestation-client-module">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-kms-client-module">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html">com.vmware.vcenter.trusted_infrastructure.trusted_clusters package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#com-vmware-vcenter-trusted-infrastructure-trusted-clusters-attestation-client-module">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#com-vmware-vcenter-trusted-infrastructure-trusted-clusters-kms-client-module">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#com-vmware-vcenter-trusted-infrastructure-attestation-client-module">com.vmware.vcenter.trusted_infrastructure.attestation_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#com-vmware-vcenter-trusted-infrastructure-kms-client-module">com.vmware.vcenter.trusted_infrastructure.kms_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-client-module">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#com-vmware-vcenter-trusted-infrastructure-trust-authority-hosts-client-module">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#com-vmware-vcenter-trusted-infrastructure-trusted-clusters-client-module">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.attestation_client">com.vmware.vcenter.trusted_infrastructure.attestation_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.kms_client">com.vmware.vcenter.trusted_infrastructure.kms_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vcha.html">com.vmware.vcenter.vcha package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vcha.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vcha.html#com-vmware-vcenter-vcha-cluster-client-module">com.vmware.vcenter.vcha.cluster_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vcha.html#module-com.vmware.vcenter.vcha.cluster_client">com.vmware.vcenter.vcha.cluster_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html">com.vmware.vcenter.vm.guest package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#com-vmware-vcenter-vm-guest-filesystem-client-module">com.vmware.vcenter.vm.guest.filesystem_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#com-vmware-vcenter-vm-guest-networking-client-module">com.vmware.vcenter.vm.guest.networking_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#module-com.vmware.vcenter.vm.guest.filesystem_client">com.vmware.vcenter.vm.guest.filesystem_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#module-com.vmware.vcenter.vm.guest.networking_client">com.vmware.vcenter.vm.guest.networking_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html">com.vmware.vcenter.vm.hardware package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#com-vmware-vcenter-vm-hardware-adapter-client-module">com.vmware.vcenter.vm.hardware.adapter_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#com-vmware-vcenter-vm-hardware-boot-client-module">com.vmware.vcenter.vm.hardware.boot_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.adapter_client">com.vmware.vcenter.vm.hardware.adapter_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.boot_client">com.vmware.vcenter.vm.hardware.boot_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html">com.vmware.vcenter.vm.storage package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#com-vmware-vcenter-vm-storage-policy-client-module">com.vmware.vcenter.vm.storage.policy_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#module-com.vmware.vcenter.vm.storage.policy_client">com.vmware.vcenter.vm.storage.policy_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#com-vmware-vcenter-vm-compute-client-module">com.vmware.vcenter.vm.compute_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#com-vmware-vcenter-vm-console-client-module">com.vmware.vcenter.vm.console_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#com-vmware-vcenter-vm-guest-client-module">com.vmware.vcenter.vm.guest_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#com-vmware-vcenter-vm-hardware-client-module">com.vmware.vcenter.vm.hardware_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#com-vmware-vcenter-vm-storage-client-module">com.vmware.vcenter.vm.storage_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#com-vmware-vcenter-vm-tools-client-module">com.vmware.vcenter.vm.tools_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.compute_client">com.vmware.vcenter.vm.compute_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.console_client">com.vmware.vcenter.vm.console_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.guest_client">com.vmware.vcenter.vm.guest_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.hardware_client">com.vmware.vcenter.vm.hardware_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.storage_client">com.vmware.vcenter.vm.storage_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.tools_client">com.vmware.vcenter.vm.tools_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vm_template.html">com.vmware.vcenter.vm_template package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#com-vmware-vcenter-vm-template-library-items-client-module">com.vmware.vcenter.vm_template.library_items_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#module-com.vmware.vcenter.vm_template.library_items_client">com.vmware.vcenter.vm_template.library_items_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-authentication-client-module">com.vmware.vcenter.authentication_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-certificate-management-client-module">com.vmware.vcenter.certificate_management_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-compute-client-module">com.vmware.vcenter.compute_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-crypto-manager-client-module">com.vmware.vcenter.crypto_manager_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-datastore-client-module">com.vmware.vcenter.datastore_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-deployment-client-module">com.vmware.vcenter.deployment_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-guest-client-module">com.vmware.vcenter.guest_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-hvc-client-module">com.vmware.vcenter.hvc_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-identity-client-module">com.vmware.vcenter.identity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-inventory-client-module">com.vmware.vcenter.inventory_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-iso-client-module">com.vmware.vcenter.iso_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-lcm-client-module">com.vmware.vcenter.lcm_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-namespace-management-client-module">com.vmware.vcenter.namespace_management_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-namespaces-client-module">com.vmware.vcenter.namespaces_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-ovf-client-module">com.vmware.vcenter.ovf_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-services-client-module">com.vmware.vcenter.services_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-storage-client-module">com.vmware.vcenter.storage_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-system-config-client-module">com.vmware.vcenter.system_config_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-tagging-client-module">com.vmware.vcenter.tagging_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-tokenservice-client-module">com.vmware.vcenter.tokenservice_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-topology-client-module">com.vmware.vcenter.topology_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-trusted-infrastructure-client-module">com.vmware.vcenter.trusted_infrastructure_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-vcha-client-module">com.vmware.vcenter.vcha_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-vm-client-module">com.vmware.vcenter.vm_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#com-vmware-vcenter-vm-template-client-module">com.vmware.vcenter.vm_template_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.authentication_client">com.vmware.vcenter.authentication_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.certificate_management_client">com.vmware.vcenter.certificate_management_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.compute_client">com.vmware.vcenter.compute_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.crypto_manager_client">com.vmware.vcenter.crypto_manager_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.datastore_client">com.vmware.vcenter.datastore_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.deployment_client">com.vmware.vcenter.deployment_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.guest_client">com.vmware.vcenter.guest_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.hvc_client">com.vmware.vcenter.hvc_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.identity_client">com.vmware.vcenter.identity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.inventory_client">com.vmware.vcenter.inventory_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.iso_client">com.vmware.vcenter.iso_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.lcm_client">com.vmware.vcenter.lcm_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.namespace_management_client">com.vmware.vcenter.namespace_management_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.namespaces_client">com.vmware.vcenter.namespaces_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.ovf_client">com.vmware.vcenter.ovf_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.services_client">com.vmware.vcenter.services_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.storage_client">com.vmware.vcenter.storage_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.system_config_client">com.vmware.vcenter.system_config_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.tagging_client">com.vmware.vcenter.tagging_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.tokenservice_client">com.vmware.vcenter.tokenservice_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.topology_client">com.vmware.vcenter.topology_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.trusted_infrastructure_client">com.vmware.vcenter.trusted_infrastructure_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vcha_client">com.vmware.vcenter.vcha_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_client">com.vmware.vcenter.vm_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_template_client">com.vmware.vcenter.vm_template_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,11 +189,446 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-recovery-backup-job-client-module">
|
||||
<h2>com.vmware.appliance.recovery.backup.job_client module<a class="headerlink" href="#com-vmware-appliance-recovery-backup-job-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.appliance.recovery.backup.job_client">
|
||||
<span id="com-vmware-appliance-recovery-backup-job-client-module"></span><h2>com.vmware.appliance.recovery.backup.job_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup.job_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.recovery.backup.job_client.</span></code><code class="sig-name descname"><span class="pre">Details</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details</span></code> class provides methods to get the details about backup
|
||||
jobs. This class was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">BuildInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details.BuildInfo</span></code> class contains information about the build of the
|
||||
appliance. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-recovery-backup-system-name-client-module">
|
||||
<h2>com.vmware.appliance.recovery.backup.system_name_client module<a class="headerlink" href="#com-vmware-appliance-recovery-backup-system-name-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>version_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Appliance product type, for example 6.8.2 GA. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Appliance version, for example 6.8.2.10000. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>build_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Build Number of the appliance. This attribute was added in vSphere
|
||||
API 6.7.2.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">jobs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing backup jobs details (see <a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.list" title="com.vmware.appliance.recovery.backup.job_client.Details.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Details.list()</span></code></a>). This
|
||||
class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>jobs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of backup jobs that can match the filter. This
|
||||
attribute was added in vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>. When methods return a
|
||||
value of this class as a return value, the attribute will contain
|
||||
identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>.
|
||||
If None the filter will match all the backup jobs.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">duration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">progress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location_user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">build</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancelable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details.Info</span></code> class contains information about a backup job. This
|
||||
class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the backup location. This attribute was added in vSphere API
|
||||
6.7.</p></li>
|
||||
<li><p><strong>duration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time in seconds since the backup job was started or the time it
|
||||
took to complete the backup job. This attribute was added in
|
||||
vSphere API 6.7.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>, or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</p></li>
|
||||
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Size of the backup data transferred to remote location. This
|
||||
attribute was added in vSphere API 6.7.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>, or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</p></li>
|
||||
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the job. This attribute was added in vSphere API 6.7.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>, or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</p></li>
|
||||
<li><p><strong>location_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The username for the remote backup location. This attribute was
|
||||
added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type" title="com.vmware.appliance.recovery.backup.job_client.Details.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.Type</span></code></a>) – Type of the backup job. Indicates whether the backup was started
|
||||
manually or as a scheduled backup. This attribute was added in
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – List of any info/warning/error messages returned by the backup job.
|
||||
This attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>build</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo" title="com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.BuildInfo</span></code></a>) – Information about the build of the appliance. This attribute was
|
||||
added in vSphere API 6.7.2.
|
||||
This attribute is optional because it was added in a newer version
|
||||
than its parent node.</p></li>
|
||||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
|
||||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||||
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||||
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
||||
as a return value, the attribute will be an identifier for the
|
||||
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
||||
This attribute will be None if the task has no parent.</p></li>
|
||||
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
||||
one the operation performed on.
|
||||
This attribute will be None if the operation has no target or
|
||||
multiple targets.</p></li>
|
||||
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
||||
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
||||
value may change as the operation progresses.</p></li>
|
||||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
||||
If None the description of why the operation failed will be
|
||||
included in the result of the operation (see
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
|
||||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||||
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
|
||||
This attribute will be None if the operation is performed by the
|
||||
system.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Type">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details.Type</span></code> class defines the type of backup job. This enumeration
|
||||
was added in vSphere API 6.7.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Type.MANUAL">
|
||||
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type.MANUAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Job type is Manual. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Type.SCHEDULED">
|
||||
<code class="sig-name descname"><span class="pre">SCHEDULED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='SCHEDULED')</span></em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type.SCHEDULED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Job type is Scheduled. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns detailed information about the current and historical backup
|
||||
jobs. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec" title="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching backup jobs for which information should
|
||||
be returned.
|
||||
If None, the behavior is equivalent to <a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec" title="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.FilterSpec</span></code></a>
|
||||
with all attributes None which means all the backup jobs match the
|
||||
filter.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.Info" title="com.vmware.appliance.recovery.backup.job_client.Details.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Map of backup job identifier to Info Structure.
|
||||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if any error occurs during the execution of the operation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.recovery.backup.job_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.appliance.recovery.backup.system_name_client">
|
||||
<span id="com-vmware-appliance-recovery-backup-system-name-client-module"></span><h2>com.vmware.appliance.recovery.backup.system_name_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup.system_name_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.recovery.backup.system_name_client.</span></code><code class="sig-name descname"><span class="pre">Archive</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Archive</span></code> class provides methods to get the backup information. This
|
||||
class was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start_timestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_timestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment_substring</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_results</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Archive.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing backup archives (see <a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Archive.list()</span></code></a>). If
|
||||
multiple attributes are specified, only backup archives matching all of the
|
||||
attributes match the filter. This class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>start_timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Backup must have been taken on or after this time to match the
|
||||
filter. This attribute was added in vSphere API 6.7.
|
||||
If None the filter will match oldest backups.</p></li>
|
||||
<li><p><strong>end_timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Backup must have been taken on or before this time to match the
|
||||
filter. This attribute was added in vSphere API 6.7.
|
||||
If None the filter will match most recent backups.</p></li>
|
||||
<li><p><strong>comment_substring</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Backup comment must contain this <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> to match the filter.
|
||||
This attribute was added in vSphere API 6.7.
|
||||
If None the filter will match backups with any comment.</p></li>
|
||||
<li><p><strong>max_results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Limit result to a max count of most recent backups. This attribute
|
||||
was added in vSphere API 6.7.
|
||||
If None it defaults to 128.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">system_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Archive.Info</span></code> class represents backup archive information. This
|
||||
class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this backup was completed. This attribute was added in
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Backup location URL. This attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>parts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of parts included in the backup. This attribute was added in
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the appliance represented by the backup. This
|
||||
attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The system name identifier of the appliance represented by the
|
||||
backup. This attribute was added in vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</p></li>
|
||||
<li><p><strong>comment</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Custom comment added by the user for this backup. This attribute
|
||||
was added in vSphere API 6.7.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">archive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Archive.Summary</span></code> class contains commonly used information about a
|
||||
backup archive. This class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>archive</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Backup archive identifier. This attribute was added in vSphere API
|
||||
6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name.archive</span></code>. When
|
||||
methods return a value of this class as a return value, the
|
||||
attribute will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name.archive</span></code>.</p></li>
|
||||
<li><p><strong>timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this backup was started. This attribute was added in
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the appliance represented by the backup archive.
|
||||
This attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>comment</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Custom comment added by the user for this backup. This attribute
|
||||
was added in vSphere API 6.7.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">system_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">archive</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the information for backup corresponding to given backup
|
||||
location and system name. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.appliance.recovery.html#com.vmware.appliance.recovery.backup_client.LocationSpec" title="com.vmware.appliance.recovery.backup_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup_client.LocationSpec</span></code></a>) – LocationSpec Structure.</p></li>
|
||||
<li><p><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – System name identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</p></li>
|
||||
<li><p><strong>archive</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Archive identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name.archive</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Info" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Info Structure.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if backup does not exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if any error occurs during the execution of the operation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loc_spec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">system_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about backup archives corresponding to given backup
|
||||
location and system name, which match the <a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.FilterSpec</span></code></a>.
|
||||
This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>loc_spec</strong> (<a class="reference internal" href="com.vmware.appliance.recovery.html#com.vmware.appliance.recovery.backup_client.LocationSpec" title="com.vmware.appliance.recovery.backup_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup_client.LocationSpec</span></code></a>) – LocationSpec Structure.</p></li>
|
||||
<li><p><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – System name identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</p></li>
|
||||
<li><p><strong>filter_spec</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.FilterSpec</span></code></a>) – Specification of matching backups for which information should be
|
||||
returned.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Commonly used information about the backup archives.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if combination of <code class="docutils literal notranslate"><span class="pre">loc_spec</span></code> and system name does not refer to an
|
||||
existing location on the backup server.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if any error occurs during the execution of the operation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.recovery.backup.system_name_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -187,11 +187,169 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-system-security-client-module">
|
||||
<h2>com.vmware.appliance.system.security_client module<a class="headerlink" href="#com-vmware-appliance-system-security-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.appliance.system.security_client">
|
||||
<span id="com-vmware-appliance-system-security-client-module"></span><h2>com.vmware.appliance.system.security_client module<a class="headerlink" href="#module-com.vmware.appliance.system.security_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.system.security_client.GlobalFips">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.system.security_client.</span></code><code class="sig-name descname"><span class="pre">GlobalFips</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.security_client.GlobalFips" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">GlobalFips</span></code> class provides methods to enable/disable appliance FIPS
|
||||
mode. This class was added in vSphere API 7.0.1.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.system.security_client.GlobalFips.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.security_client.GlobalFips.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-system-time-client-module">
|
||||
<h2>com.vmware.appliance.system.time_client module<a class="headerlink" href="#com-vmware-appliance-system-time-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – FIPS setting state. This attribute was added in vSphere API
|
||||
7.0.1.0.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.system.security_client.GlobalFips.UpdateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.security_client.GlobalFips.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – FIPS setting state. This attribute was added in vSphere API
|
||||
7.0.1.0.
|
||||
If None, the value is unchanged.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.appliance.system.security_client.GlobalFips.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.security_client.GlobalFips.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get current appliance FIPS settings. This method was added in vSphere
|
||||
API 7.0.1.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.system.security_client.GlobalFips.Info" title="com.vmware.appliance.system.security_client.GlobalFips.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalFips.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Current FIPS settings state.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
Generic error</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.appliance.system.security_client.GlobalFips.update">
|
||||
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.security_client.GlobalFips.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable/Disable Global FIPS mode for the appliance.</p>
|
||||
<p><strong>Caution:</strong> Changing the value of this setting will reboot the
|
||||
Appliance.. This method was added in vSphere API 7.0.1.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.system.security_client.GlobalFips.UpdateSpec" title="com.vmware.appliance.system.security_client.GlobalFips.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalFips.UpdateSpec</span></code></a>) – </p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
Generic error</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.system.security_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.system.security_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.security_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.appliance.system.time_client">
|
||||
<span id="com-vmware-appliance-system-time-client-module"></span><h2>com.vmware.appliance.system.time_client module<a class="headerlink" href="#module-com.vmware.appliance.system.time_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.system.time_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.system.time_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.time_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.system.time_client.Timezone">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.system.time_client.</span></code><code class="sig-name descname"><span class="pre">Timezone</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.time_client.Timezone" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Timezone</span></code> class provides methods to get and set the appliance
|
||||
timezone. This class was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.appliance.system.time_client.Timezone.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.time_client.Timezone.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get time zone. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Time zone name.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if timezone cannot be read.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.appliance.system.time_client.Timezone.set">
|
||||
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.time_client.Timezone.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set time zone. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Time zone name.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if passed arguments are invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if any error occurs during the execution of the operation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -199,39 +199,39 @@
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datacenter-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datastore-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-folder-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-host-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-network-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-resourcepool-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-applmgmt-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-authmanagement-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#com-vmware-appliance-vcenter-settings-v1-config-components-client-module">com.vmware.appliance.vcenter.settings.v1.config.components_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#module-com.vmware.appliance.vcenter.settings.v1.config.components_client">com.vmware.appliance.vcenter.settings.v1.config.components_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#com-vmware-appliance-vcenter-settings-v1-config-client-module">com.vmware.appliance.vcenter.settings.v1.config_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#module-com.vmware.appliance.vcenter.settings.v1.config_client">com.vmware.appliance.vcenter.settings.v1.config_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#com-vmware-appliance-vcenter-settings-v1-client-module">com.vmware.appliance.vcenter.settings.v1_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#module-com.vmware.appliance.vcenter.settings.v1_client">com.vmware.appliance.vcenter.settings.v1_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -200,9 +200,9 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-drs-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-ha-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-vsan-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -211,26 +211,695 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client</span></code>
|
||||
module provides classes to manage the vCenter Server Inventory cluster
|
||||
configurations</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.</span></code><code class="sig-name descname"><span class="pre">ClusterConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_vm_overrides</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drs_vm_overrides</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rules</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proactive_ha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_pools</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterConfigInfo</span></code> class contains attributes describing the complete
|
||||
configuration of a cluster. It contains cluster-wide configurations of DRS,
|
||||
HA VSAN Cluster etc.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datacenter-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datacenter-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the cluster</p></li>
|
||||
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path from root folder to cluster’s parent.
|
||||
If None, then inventory object placed in root folder.</p></li>
|
||||
<li><p><strong>ha</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of vsphere HA configurations for clusters.
|
||||
If None, then HA configurations are not set.</p></li>
|
||||
<li><p><strong>ha_vm_overrides</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Settings for HA vm overrides.</p></li>
|
||||
<li><p><strong>drs</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide configuration of the vSphere DRS service.</p></li>
|
||||
<li><p><strong>drs_vm_overrides</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of virtual machine configurations for the vSphere DRS service.
|
||||
Each entry applies to one virtual machine. If a virtual machine is
|
||||
not specified in this list, the service uses the default settings
|
||||
for that virtual machine.
|
||||
If None or empty, the value is skipped.</p></li>
|
||||
<li><p><strong>rules</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide rules.
|
||||
If None or empty, the value is skipped.</p></li>
|
||||
<li><p><strong>groups</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide groups.
|
||||
If None or empty, the value is skipped.</p></li>
|
||||
<li><p><strong>proactive_ha</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide configuration of the vSphere InfraUpdateHA service.
|
||||
If None or empty, the value is skipped.</p></li>
|
||||
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Host configuration on the datacenter.
|
||||
If None, then no hosts present in the datacenter.</p></li>
|
||||
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the cluster.
|
||||
If None, then no permissions defined on this inventory object.</p></li>
|
||||
<li><p><strong>resource_pools</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Resource pools.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.</span></code><code class="sig-name descname"><span class="pre">OptionValue</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Describes the key/value pair of a configured option.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datastore-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datastore-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The name of the option using dot notation to reflect the option’s
|
||||
position in a hierarchy. For example, you might have an option
|
||||
called “Ethernet” and another option that is a child of that called
|
||||
“Connection”. In this case, the key for the latter could be defined
|
||||
as “Ethernet.Connection”</p></li>
|
||||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The value of the option. The Any data object type enables you to
|
||||
define any value for the option. Typically, however, the value of
|
||||
an option is of type String or Integer.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-folder-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-folder-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datacenter-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The {\@name
|
||||
com.vmware.appliance.vcenter.settings.v1.config.components.inventory
|
||||
.datacenter} module provides classes to manage the datacenter config.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.</span></code><code class="sig-name descname"><span class="pre">Datacenter</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standalone_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code> class contains spec to define datacenter in vCenter
|
||||
Server.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-host-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-host-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the datacenter.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter</span></code>.
|
||||
When methods return a value of this class as a return value, the
|
||||
attribute will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter</span></code>.</p></li>
|
||||
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of the inventory object’s parent.
|
||||
If None, then inventory object placed in root folder.</p></li>
|
||||
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the datacenter.
|
||||
If None, then no permissions defined on this inventory object.</p></li>
|
||||
<li><p><strong>standalone_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Host configuration on the datacenter.
|
||||
If None, then no hosts present in the datacenter.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-network-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-network-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datastore-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The {\@name
|
||||
com.vmware.appliance.vcenter.settings.v1.config.components.inventory
|
||||
.datastore} module provides classes to manage the datastore and storagepod
|
||||
config.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">Datastore</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Datastore</span></code> class defines the spec for datastore configurations in
|
||||
vCenter Server.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-resourcepool-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-resourcepool-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the datastore.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore</span></code>.
|
||||
When methods return a value of this class as a return value, the
|
||||
attribute will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore</span></code>.</p></li>
|
||||
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
|
||||
<li><p><strong>summary</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Summary of the datastore.</p></li>
|
||||
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the datastore.
|
||||
If None, then no permissions defined on this inventory object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">MaintenanceModeState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">MaintenanceModeState</span></code> class defines the maintenance mode states of
|
||||
the datastore.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState"><code class="xref py py-class docutils literal notranslate"><span class="pre">MaintenanceModeState</span></code></a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.ENTERING_MAINTENANCE">
|
||||
<code class="sig-name descname"><span class="pre">ENTERING_MAINTENANCE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceModeState(string='ENTERING_MAINTENANCE')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.ENTERING_MAINTENANCE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Started entering maintenance mode, but not finished. This could happen when
|
||||
waiting for user input or for long-running vmotions to complete.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.IN_MAINTENANCE">
|
||||
<code class="sig-name descname"><span class="pre">IN_MAINTENANCE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceModeState(string='IN_MAINTENANCE')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.IN_MAINTENANCE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Successfully entered maintenance mode.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.NORMAL">
|
||||
<code class="sig-name descname"><span class="pre">NORMAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceModeState(string='NORMAL')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.NORMAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default state.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">PodStorageDrsEntry</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage_drs_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The PodStorageDrsEntry class contains spec to define storage DRS related
|
||||
attributes of the Storage Pod.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>storage_drs_config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDrsConfigInfo</span></code></a>) – Storage DRS configuration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StorageDrsConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pod_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The StorageDrsConfigInfo class contains spec to define storage DRS
|
||||
configurations.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>pod_config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDrsPodConfigInfo</span></code></a>) – Pod-wide configuration information for the storage DRS service.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StorageDrsPodConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The StorageDrsConfigInfo class contains spec to define pod-wide
|
||||
configuration information for the storage DRS service.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether or not storage DRS is enabled.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StoragePod</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pod_storage_drs_entry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The StoragePod class contains spec to define storage pod in vCenter Server.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Storage Pod.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.storagepod</span></code>.
|
||||
When methods return a value of this class as a return value, the
|
||||
attribute will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.storagepod</span></code>.</p></li>
|
||||
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
|
||||
<li><p><strong>pod_storage_drs_entry</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">PodStorageDrsEntry</span></code></a>) – Storage DRS related attributes of the Storage Pod.</p></li>
|
||||
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the Storage Pod.
|
||||
If None, then no permissions defined on this inventory object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multiple_host_access</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maintenance_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Summary</span></code> class defines the datastore summary properties.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum capacity of this datastore, in bytes. This value is updated
|
||||
periodically by the server. It can be explicitly refreshed with the
|
||||
Refresh operation.</p></li>
|
||||
<li><p><strong>multiple_host_access</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – More than one host in the datacenter has been configured with
|
||||
access to the datastore. This is only provided by VirtualCenter.
|
||||
If None, then the datastore not configured with access from more
|
||||
than one host.</p></li>
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Type of file system volume, such as VMFS or NFS.</p></li>
|
||||
<li><p><strong>maintenance_mode</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState"><code class="xref py py-class docutils literal notranslate"><span class="pre">MaintenanceModeState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The current maintenance mode state of the datastore.
|
||||
If None, then the current maintenance mode state of the datastore
|
||||
is set to normal.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-folder-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The {\@name
|
||||
com.vmware.appliance.vcenter.settings.v1.config.components.inventory .folder}
|
||||
module provides classes to manage the folder config.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.</span></code><code class="sig-name descname"><span class="pre">Folder</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datacenter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The Folder class contains spec to define folder in vCenter Server.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of datastore folders.
|
||||
If None. then there are no datastore folders.</p></li>
|
||||
<li><p><strong>datacenter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of datacenter folders.
|
||||
If None. then there are no datacenter folders.</p></li>
|
||||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of vm folders.
|
||||
If None. then there are no vm folders.</p></li>
|
||||
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of network folders.
|
||||
If None. then there are no network folders.</p></li>
|
||||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of host folders.
|
||||
If None. then there are no host folders.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.</span></code><code class="sig-name descname"><span class="pre">FolderDetails</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The FolderDetails class contains spec to define folder in vCenter Server.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the vCenter Server folder.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder</span></code>.
|
||||
When methods return a value of this class as a return value, the
|
||||
attribute will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder</span></code>.</p></li>
|
||||
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of the inventory object’s parent.
|
||||
If None, then inventory object placed in root folder.</p></li>
|
||||
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the folder.
|
||||
If None, then no permissions defined on this inventory object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-host-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The {\@name com.vmware.appliance.vcenter.settings.v1.config.components
|
||||
inventory.host} module provides classes to manage the ConfigManagement.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.</span></code><code class="sig-name descname"><span class="pre">HostConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">HostConfig</span></code> class contains attributes describing the configuration
|
||||
of a Stand alone host.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the host</p></li>
|
||||
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permission on the host.
|
||||
If None, then no permissions defined on this inventory object.</p></li>
|
||||
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of this inventory object.
|
||||
If None, then inventory object placed in root folder.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-network-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The {\@name
|
||||
com.vmware.appliance.vcenter.settings.v1.config.components.inventory .network}
|
||||
module provides classes to manage the network config.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.</span></code><code class="sig-name descname"><span class="pre">Network</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The Network class contains spec to define standard network in vCenter
|
||||
Server.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the network.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network</span></code>.
|
||||
When methods return a value of this class as a return value, the
|
||||
attribute will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network</span></code>.</p></li>
|
||||
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
|
||||
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the network.
|
||||
If None, then no permissions defined on this inventory object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-resourcepool-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The {\@name com.vmware.appliance.vcenter.settings.v1.config.components
|
||||
inventory.resourcepool} module provides classes to manage the ConfigManagement.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">ResourceAllocationInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expandable_reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shares</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code> class contains resource allocation
|
||||
information of a resource pool.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Amount of resource that is guaranteed available to a resource pool.
|
||||
Reserved resources are not wasted if they are not used. If the
|
||||
utilization is less than the reservation, the resources can be
|
||||
utilized by other running virtual machines. Units are MB fo memory,
|
||||
and MHz for CPU.</p></li>
|
||||
<li><p><strong>expandable_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – In a resource pool with an expandable reservation, the reservation
|
||||
can grow beyond the specified value, if the parent resource pool
|
||||
has unreserved resources. A non-expandable reservation is called a
|
||||
fixed reservation.</p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The utilization of a resource pool will not exceed this limit, even
|
||||
if there are available resources. This is typically used to ensure
|
||||
a consistent performance of resource pools independent of available
|
||||
resources. If set to -1, then there is no fixed limit on resource
|
||||
usage (only bounded by available resources and shares). Units are
|
||||
MB for memory, and MHz for CPU.</p></li>
|
||||
<li><p><strong>shares</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shares</span></code></a>) – Shares are used in case of resource contention.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">ResourcePool</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">child_resource_pools</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> class contains information about resource pools
|
||||
present in the cluster.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the vCenter Server resource pool.</p></li>
|
||||
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent name for the resource pool.
|
||||
If None, then inventory object placed in root folder.</p></li>
|
||||
<li><p><strong>child_resource_pools</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of the child resource pools contained in this resource
|
||||
pool.
|
||||
If None or empty, the value is skipped.</p></li>
|
||||
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePoolSummary</span></code></a>) – Summary of the Resource pools.</p></li>
|
||||
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permission on the resourcepool.
|
||||
If None, then no permissions defined on this inventory object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">ResourcePoolSummary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu_allocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_allocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePoolSummary</span></code> class provides summary of ResourcePool.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cpu_allocation</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a>) – Resource allocation information for CPU.</p></li>
|
||||
<li><p><strong>memory_allocation</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a>) – Resource allocation information for memory.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">Shares</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shares</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Shares</span></code> class provides specification of shares.</p>
|
||||
<p>Shares are used to determine relative allocation between resource
|
||||
consumers. In general, a consumer with more shares gets proportionally more
|
||||
of the resource, subject to certain other constraints.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>level</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shares.Level</span></code></a>) – The allocation level. It maps to a pre-determined set of numeric
|
||||
values for shares. If the shares value does not map to a predefined
|
||||
size, then the level is set as CUSTOM.</p></li>
|
||||
<li><p><strong>shares</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <p>When <code class="xref py py-attr docutils literal notranslate"><span class="pre">Shares.level</span></code> is set to CUSTOM, it is the number of
|
||||
shares allocated. Otherwise, this value is ignored.</p>
|
||||
<p>There is no unit for this value. It is a relative measure based on
|
||||
the settings for other resource pools.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Level</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Shares.Level</span></code> class defines the possible values for the allocation
|
||||
level.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Level</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.CUSTOM">
|
||||
<code class="sig-name descname"><span class="pre">CUSTOM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='CUSTOM')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.CUSTOM" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, in case there is resource contention the server uses the
|
||||
shares value to determine the resource allocation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.HIGH">
|
||||
<code class="sig-name descname"><span class="pre">HIGH</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='HIGH')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.HIGH" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="simple">
|
||||
<dt>For CPU: Shares = 2000 * nmumber of virtual CPUs.</dt><dd><p>For Memory: Shares = 20 * virtual machine memory size in MB.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.LOW">
|
||||
<code class="sig-name descname"><span class="pre">LOW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='LOW')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.LOW" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="simple">
|
||||
<dt>For CPU: Shares = 500 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 5 * virtual machine memory size in MB.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.NORMAL">
|
||||
<code class="sig-name descname"><span class="pre">NORMAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='NORMAL')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.NORMAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="simple">
|
||||
<dt>For CPU: Shares = 1000 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 10 * virtual machine memory size in MB.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -200,29 +200,29 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-drs-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-ha-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-vsan-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datacenter-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datastore-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-folder-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-host-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-network-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-resourcepool-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-applmgmt-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-authmanagement-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -231,8 +231,22 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-components-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config.components_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-components-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components_client</span></code>
|
||||
module provides classes to manage the ConfigManagement.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -200,35 +200,35 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-drs-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-ha-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-vsan-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datacenter-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datastore-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-folder-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-host-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-network-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-resourcepool-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-applmgmt-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-authmanagement-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com-vmware-appliance-vcenter-settings-v1-config-components-inventory-client-module">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#com-vmware-appliance-vcenter-settings-v1-config-components-client-module">com.vmware.appliance.vcenter.settings.v1.config.components_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#module-com.vmware.appliance.vcenter.settings.v1.config.components_client">com.vmware.appliance.vcenter.settings.v1.config.components_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -237,8 +237,22 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-appliance-vcenter-settings-v1-config-client-module">
|
||||
<h2>com.vmware.appliance.vcenter.settings.v1.config_client module<a class="headerlink" href="#com-vmware-appliance-vcenter-settings-v1-config-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config_client">
|
||||
<span id="com-vmware-appliance-vcenter-settings-v1-config-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config_client</span></code> module provides
|
||||
classes to manage the ConfigManagement.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.appliance.vcenter.settings.v1.config_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,11 +189,957 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-content-library-item-downloadsession-client-module">
|
||||
<h2>com.vmware.content.library.item.downloadsession_client module<a class="headerlink" href="#com-vmware-content-library-item-downloadsession-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.content.library.item.downloadsession_client">
|
||||
<span id="com-vmware-content-library-item-downloadsession-client-module"></span><h2>com.vmware.content.library.item.downloadsession_client module<a class="headerlink" href="#module-com.vmware.content.library.item.downloadsession_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Content Library Item Download Session module provides classes and classes
|
||||
for downloading files in a session.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.downloadsession_client.</span></code><code class="sig-name descname"><span class="pre">File</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File</span></code> class provides methods for accessing files within a download
|
||||
session.</p>
|
||||
<p>After a download session is created against a library item, the <code class="docutils literal notranslate"><span class="pre">File</span></code>
|
||||
class can be used to retrieve all downloadable content within the library
|
||||
item. Since the content may not be available immediately in a downloadable
|
||||
form on the server side, the client will have to prepare the file and wait
|
||||
for the file status to become <a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED" title="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.PrepareStatus.PREPARED</span></code></a>.</p>
|
||||
<blockquote>
|
||||
<div><p>See <a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.DownloadSession" title="com.vmware.content.library.item_client.DownloadSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.DownloadSession</span></code></a>.</p>
|
||||
</div></blockquote>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.EndpointType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EndpointType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File.EndpointType</span></code> class defines the types of endpoints used to
|
||||
download the file.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-content-library-item-updatesession-client-module">
|
||||
<h2>com.vmware.content.library.item.updatesession_client module<a class="headerlink" href="#com-vmware-content-library-item-updatesession-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointType</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT">
|
||||
<code class="sig-name descname"><span class="pre">DIRECT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">EndpointType(string='DIRECT')</span></em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A direct download endpoint indicating the location of the file on storage.
|
||||
The caller is responsible for retrieving the file from the storage location
|
||||
directly.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS">
|
||||
<code class="sig-name descname"><span class="pre">HTTPS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">EndpointType(string='HTTPS')</span></em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>An https download endpoint.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bytes_transferred</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">checksum_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File.Info</span></code> class defines the downloaded file.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the file.</p></li>
|
||||
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The file size, in bytes.
|
||||
This attribute may not be available immediately. It is guaranteed
|
||||
to be set when the client finishes downloading the file.</p></li>
|
||||
<li><p><strong>bytes_transferred</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The number of bytes that have been transferred by the server so far
|
||||
for making this file prepared for download. This value may stay at
|
||||
zero till the client starts downloading the file.</p></li>
|
||||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus" title="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.PrepareStatus</span></code></a>) – The preparation status (UNPREPARED, PREPARE_REQUESTED, PREPARING,
|
||||
PREPARED, ERROR) of the file.</p></li>
|
||||
<li><p><strong>download_endpoint</strong> (<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferEndpoint" title="com.vmware.content.library.item_client.TransferEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.TransferEndpoint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Endpoint at which the file is available for download. The value is
|
||||
valid only when the <code class="xref py py-attr docutils literal notranslate"><span class="pre">File.Info.status</span></code> is
|
||||
<a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED" title="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.PrepareStatus.PREPARED</span></code></a>.
|
||||
This attribute won’t be set until the file status is
|
||||
<a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED" title="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.PrepareStatus.PREPARED</span></code></a>.</p></li>
|
||||
<li><p><strong>checksum_info</strong> (<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.File.ChecksumInfo" title="com.vmware.content.library.item_client.File.ChecksumInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.File.ChecksumInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The checksum information of the file. When the download is
|
||||
complete, you can retrieve the checksum from the <a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.get" title="com.vmware.content.library.item.downloadsession_client.File.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">File.get()</span></code></a>
|
||||
method to verify the checksum for the downloaded file.
|
||||
The checksum is always calculated for the downloaded file, but this
|
||||
attribute won’t be set until the download is complete.</p></li>
|
||||
<li><p><strong>error_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error message for a failed preparation when the prepare status is
|
||||
<a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.ERROR" title="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.PrepareStatus.ERROR</span></code></a>.
|
||||
This attribute won’t be set unless there was an error with the file
|
||||
transfer.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PrepareStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File.PrepareStatus</span></code> class defines the state of the file in
|
||||
preparation for download.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">PrepareStatus</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.ERROR">
|
||||
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PrepareStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepare failed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED">
|
||||
<code class="sig-name descname"><span class="pre">PREPARED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PrepareStatus(string='PREPARED')</span></em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepare succeeded. The file is ready for download.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARE_REQUESTED">
|
||||
<code class="sig-name descname"><span class="pre">PREPARE_REQUESTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PrepareStatus(string='PREPARE_REQUESTED')</span></em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARE_REQUESTED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A prepare has been requested, however the server hasn’t started the
|
||||
preparation yet.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARING">
|
||||
<code class="sig-name descname"><span class="pre">PREPARING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PrepareStatus(string='PREPARING')</span></em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A prepare has been requested and the file is in the process of being
|
||||
prepared.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.UNPREPARED">
|
||||
<code class="sig-name descname"><span class="pre">UNPREPARED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PrepareStatus(string='UNPREPARED')</span></em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.UNPREPARED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The file hasn’t been requested for preparation.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">download_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves file download information for a specific file.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p></li>
|
||||
<li><p><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the file requested.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.Info" title="com.vmware.content.library.item.downloadsession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.Info" title="com.vmware.content.library.item.downloadsession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> instance containing the status of the file
|
||||
and its download link if available.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the download session associated with <code class="docutils literal notranslate"><span class="pre">download_session_id</span></code>
|
||||
does not exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if there is no file with the specified <code class="docutils literal notranslate"><span class="pre">file_name</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">download_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists the information of all the files in the library item associated
|
||||
with the download session.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.list" title="com.vmware.content.library.item.downloadsession_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.Info" title="com.vmware.content.library.item.downloadsession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.list" title="com.vmware.content.library.item.downloadsession_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.Info" title="com.vmware.content.library.item.downloadsession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> instances.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the download session associated with <code class="docutils literal notranslate"><span class="pre">download_session_id</span></code>
|
||||
doesn’t exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.prepare">
|
||||
<code class="sig-name descname"><span class="pre">prepare</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">download_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.prepare" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Requests a file to be prepared for download.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p></li>
|
||||
<li><p><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the file requested for download.</p></li>
|
||||
<li><p><strong>endpoint_type</strong> (<a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType" title="com.vmware.content.library.item.downloadsession_client.File.EndpointType"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.EndpointType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Endpoint type request, one of HTTPS, DIRECT. This will determine
|
||||
the type of the <code class="xref py py-attr docutils literal notranslate"><span class="pre">File.Info.download_endpoint</span></code> that is
|
||||
generated when the file is prepared. The
|
||||
<a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT" title="com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.EndpointType.DIRECT</span></code></a> is only available to users who
|
||||
have the ContentLibrary.ReadStorage privilege.
|
||||
If not specified the default is <a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS" title="com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.EndpointType.HTTPS</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.Info" title="com.vmware.content.library.item.downloadsession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>File information containing the status of the request and the
|
||||
download link to the file.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the download session does not exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if there is no file with the specified <code class="docutils literal notranslate"><span class="pre">file_name</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the the download session wasn’t created with the
|
||||
ContentLibrary.ReadStorage privilege and the caller requested a
|
||||
<a class="reference internal" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT" title="com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.EndpointType.DIRECT</span></code></a> endpoint type.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.downloadsession_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.content.library.item.updatesession_client">
|
||||
<span id="com-vmware-content-library-item-updatesession-client-module"></span><h2>com.vmware.content.library.item.updatesession_client module<a class="headerlink" href="#module-com.vmware.content.library.item.updatesession_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Content Library Item Update Session module provides classes and classes for
|
||||
updating files in a session.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.CertificateInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.updatesession_client.</span></code><code class="sig-name descname"><span class="pre">CertificateInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">issuer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">self_signed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x509</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.CertificateInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CertificateInfo</span></code> class contains information about the public key
|
||||
certificate used to sign the content. This class was added in vSphere API
|
||||
6.8.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate issuer. For example: /C=US/ST=California/L=Palo
|
||||
Alto/O=VMware, Inc. This attribute was added in vSphere API 6.8.</p></li>
|
||||
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate subject. For example:
|
||||
C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC
|
||||
Avamar/CN=EMC Corporation. This attribute was added in vSphere API
|
||||
6.8.</p></li>
|
||||
<li><p><strong>self_signed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether the certificate is self-signed. This attribute was added in
|
||||
vSphere API 6.8.</p></li>
|
||||
<li><p><strong>x509</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The X509 representation of the certificate. This attribute was
|
||||
added in vSphere API 6.8.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.updatesession_client.</span></code><code class="sig-name descname"><span class="pre">File</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File</span></code> class provides methods for accessing files within an update
|
||||
session.</p>
|
||||
<p>After an update session is created against a library item, the <code class="docutils literal notranslate"><span class="pre">File</span></code>
|
||||
class can be used to make changes to the underlying library item metadata
|
||||
as well as the content of the files. The following changes can be made:</p>
|
||||
<ul class="simple">
|
||||
<li><p>deleting an existing file within the library item. This deletes both the
|
||||
metadata and the content.</p></li>
|
||||
<li><p>updating an existing file with new content.</p></li>
|
||||
<li><p>adding a new file to the library item.</p></li>
|
||||
</ul>
|
||||
<p>The above changes are not applied or visible until the session is
|
||||
completed. See
|
||||
<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.UpdateSession" title="com.vmware.content.library.item_client.UpdateSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.UpdateSession</span></code></a>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.AddSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">AddSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">checksum_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.AddSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File.AddSpec</span></code> class describes the properties of the file to be
|
||||
uploaded.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the file being uploaded.</p></li>
|
||||
<li><p><strong>source_type</strong> (<a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.SourceType" title="com.vmware.content.library.item.updatesession_client.File.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.SourceType</span></code></a>) – The source type (NONE, PUSH, PULL) from which the file content will
|
||||
be retrieved.</p></li>
|
||||
<li><p><strong>source_endpoint</strong> (<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferEndpoint" title="com.vmware.content.library.item_client.TransferEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.TransferEndpoint</span></code></a>) – Location from which the Content Library Service will fetch the
|
||||
file, rather than requiring a client to upload the file.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL" title="com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.SourceType.PULL</span></code></a>.</p></li>
|
||||
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The file size, in bytes.
|
||||
If None, the server will not verify it received the correct size.</p></li>
|
||||
<li><p><strong>checksum_info</strong> (<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.File.ChecksumInfo" title="com.vmware.content.library.item_client.File.ChecksumInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.File.ChecksumInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The checksum of the file. If specified, the server will verify the
|
||||
checksum once the file is received. If there is a mismatch, the
|
||||
upload will fail. For ova files, this value should not be set.
|
||||
If None, the server will not verify the checksum.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">checksum_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upload_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bytes_transferred</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_in_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File.Info</span></code> class defines the uploaded file.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the file.</p></li>
|
||||
<li><p><strong>source_type</strong> (<a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.SourceType" title="com.vmware.content.library.item.updatesession_client.File.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.SourceType</span></code></a>) – The source type (NONE, PUSH, PULL) from which the file is being
|
||||
retrieved. This may be <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.NONE" title="com.vmware.content.library.item.updatesession_client.File.SourceType.NONE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.SourceType.NONE</span></code></a> if the file is
|
||||
not being changed.</p></li>
|
||||
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The file size, in bytes as received by the server. This attribute
|
||||
is guaranteed to be set when the server has completely received the
|
||||
file.
|
||||
This attribute won’t be set until the file status is
|
||||
<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferStatus.READY" title="com.vmware.content.library.item_client.TransferStatus.READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.TransferStatus.READY</span></code></a>.</p></li>
|
||||
<li><p><strong>checksum_info</strong> (<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.File.ChecksumInfo" title="com.vmware.content.library.item_client.File.ChecksumInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.File.ChecksumInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The checksum information of the file received by the server.
|
||||
If None, the server does not verify the checksum.</p></li>
|
||||
<li><p><strong>source_endpoint</strong> (<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferEndpoint" title="com.vmware.content.library.item_client.TransferEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.TransferEndpoint</span></code></a>) – A source endpoint from which to retrieve the file.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL" title="com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.SourceType.PULL</span></code></a>.</p></li>
|
||||
<li><p><strong>upload_endpoint</strong> (<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferEndpoint" title="com.vmware.content.library.item_client.TransferEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.TransferEndpoint</span></code></a>) – An upload endpoint to which the client can push the content.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH" title="com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.SourceType.PUSH</span></code></a>.</p></li>
|
||||
<li><p><strong>bytes_transferred</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The number of bytes of this file that have been received by the
|
||||
server.</p></li>
|
||||
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferStatus" title="com.vmware.content.library.item_client.TransferStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.TransferStatus</span></code></a>) – The transfer status (WAITING_FOR_TRANSFER, TRANSFERRING, READY,
|
||||
VALIDATING, ERROR) of this file.</p></li>
|
||||
<li><p><strong>error_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details about the transfer error.
|
||||
An error message is set if the status is
|
||||
<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferStatus.ERROR" title="com.vmware.content.library.item_client.TransferStatus.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.TransferStatus.ERROR</span></code></a>.</p></li>
|
||||
<li><p><strong>keep_in_storage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Whether or not the file will be kept in storage upon update session
|
||||
completion. The flag is true for most files, and false for metadata
|
||||
files such as manifest and certificate file of update session with
|
||||
library item type OVF. Any file with
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">File.Info.keep_in_storage</span></code> set to false will not show up in
|
||||
the list of files returned from
|
||||
<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.File.list" title="com.vmware.content.library.item_client.File.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.File.list()</span></code></a> upon
|
||||
update session completion. This attribute was added in vSphere API
|
||||
6.8.
|
||||
If None, the file will be kept in storage upon update session
|
||||
completion.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.SourceType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SourceType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File.SourceType</span></code> class defines how the file content is retrieved.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.SourceType.NONE">
|
||||
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SourceType(string='NONE')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>No source type has been requested.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.SourceType.PULL">
|
||||
<code class="sig-name descname"><span class="pre">PULL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SourceType(string='PULL')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The server is pulling content from a URL. The URL scheme can be <code class="docutils literal notranslate"><span class="pre">http</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">https</span></code>, <code class="docutils literal notranslate"><span class="pre">file</span></code>, or <code class="docutils literal notranslate"><span class="pre">ds</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH">
|
||||
<code class="sig-name descname"><span class="pre">PUSH</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SourceType(string='PUSH')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The client is uploading content using HTTP(S) PUT requests.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.ValidationError">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ValidationError</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.ValidationError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File.ValidationError</span></code> class defines the validation error of a file
|
||||
in the session.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the file.</p></li>
|
||||
<li><p><strong>error_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A message indicating why the file was considered invalid.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.ValidationResult">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ValidationResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">has_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missing_files</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invalid_files</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.ValidationResult" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">File.ValidationResult</span></code> class defines the result of validating the
|
||||
files in the session.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>has_errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether the validation was succesful or not. In case of errors, the
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">File.ValidationResult.missing_files</span></code> and
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">File.ValidationResult.invalid_files</span></code> will contain at least
|
||||
one entry.</p></li>
|
||||
<li><p><strong>missing_files</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> containing the names of the files that are required
|
||||
but the client hasn’t added.</p></li>
|
||||
<li><p><strong>invalid_files</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.ValidationError" title="com.vmware.content.library.item.updatesession_client.File.ValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.ValidationError</span></code></a>) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> containing the files that have been identified as
|
||||
invalid and details about the error.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.add">
|
||||
<code class="sig-name descname"><span class="pre">add</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Requests file content to be changed (either created, or updated).
|
||||
Depending on the source type of the file, this method will either
|
||||
return an upload endpoint where the client can push the content, or the
|
||||
server will pull from the provided source endpoint. If a file with the
|
||||
same name already exists in this session, this method will be used to
|
||||
update the content of the existing file.</p>
|
||||
<p>When importing a file directly from storage, where the source endpoint
|
||||
is a file or datastore URI, you will need to have the
|
||||
ContentLibrary.ReadStorage privilege on the library item. If the file
|
||||
is located in the same directory as the library storage backing folder,
|
||||
the server will move the file instead of copying it, thereby allowing
|
||||
instantaneous import of files for efficient backup and restore
|
||||
scenarios. In all other cases, a copy is performed rather than a move.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session to be modified.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p></li>
|
||||
<li><p><strong>file_spec</strong> (<a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.AddSpec" title="com.vmware.content.library.item.updatesession_client.File.AddSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.AddSpec</span></code></a>) – Specification for the file that needs to be added or updated. This
|
||||
includes whether the client wants to push the content or have the
|
||||
server pull it.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.Info" title="com.vmware.content.library.item.updatesession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>An <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.Info" title="com.vmware.content.library.item.updatesession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> class containing upload links as well as
|
||||
server side state tracking the transfer of the file.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the <code class="docutils literal notranslate"><span class="pre">file_spec</span></code> is invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the update session doesn’t exist.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller doesn’t have ContentLibrary.ReadStorage privilege on
|
||||
the library item of the update session and source type
|
||||
<a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL" title="com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.SourceType.PULL</span></code></a> is requested for a file or datastore
|
||||
source endpoint (that is, not HTTP or HTTPs based endpoint).</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if the content of the library item associated with the update
|
||||
session has been deleted from the storage backings (see
|
||||
LibraryModel#storageBackings) associated with it.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if metadata files such as manifest and certificate file are added
|
||||
after the OVF descriptor file. This is applicable to update
|
||||
sessions with library item type OVF only. This error was added in
|
||||
vSphere 6.8.0.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves information about a specific file in the snapshot of the
|
||||
library item at the time when the update session was created.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p></li>
|
||||
<li><p><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the file.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.Info" title="com.vmware.content.library.item.updatesession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the file.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the update session doesn’t exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the file doesn’t exist in the library item associated with the
|
||||
update session.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists all files in the library item associated with the update session.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.list" title="com.vmware.content.library.item.updatesession_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.Info" title="com.vmware.content.library.item.updatesession_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.list" title="com.vmware.content.library.item.updatesession_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of the files in the library item associated with
|
||||
the update session. This <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.list" title="com.vmware.content.library.item.updatesession_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> may be empty if the caller
|
||||
has removed all the files as part of this session (in which case
|
||||
completing the update session will result in an empty library
|
||||
item).</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the update session doesn’t exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.remove">
|
||||
<code class="sig-name descname"><span class="pre">remove</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Requests a file to be removed. The file will only be effectively
|
||||
removed when the update session is completed.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p></li>
|
||||
<li><p><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the file to be removed.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the update session doesn’t exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the file doesn’t exist in the library item associated with the
|
||||
update session.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.validate">
|
||||
<code class="sig-name descname"><span class="pre">validate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.validate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Validates the files in the update session with the referenced
|
||||
identifier and ensures all necessary files are received. In the case
|
||||
where a file is missing, this method will return its name in the
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">File.ValidationResult.missing_files</span></code> set. The user can add the
|
||||
missing files and try re-validating. For other type of errors,
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">File.ValidationResult.invalid_files</span></code> will contain the list of
|
||||
invalid files.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session to validate.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.File.ValidationResult" title="com.vmware.content.library.item.updatesession_client.File.ValidationResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.ValidationResult</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>A validation result containing missing files or invalid files and
|
||||
the reason why they are invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if no update session with the given identifier exists.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if the update session is not in the
|
||||
<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE</span></code></a>
|
||||
state, or if some of the files that will be uploaded by the client
|
||||
aren’t received correctly.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.updatesession_client.</span></code><code class="sig-name descname"><span class="pre">PreviewInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">PreviewInfo</span></code> class contains information about the files being
|
||||
uploaded in the update session. This class was added in vSphere API 6.8.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State" title="com.vmware.content.library.item.updatesession_client.PreviewInfo.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">PreviewInfo.State</span></code></a>) – Indicates the state of the preview of the update session. This
|
||||
attribute was added in vSphere API 6.8.</p></li>
|
||||
<li><p><strong>certificate_info</strong> (<a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.CertificateInfo" title="com.vmware.content.library.item.updatesession_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The certificate information of the signed update session content.
|
||||
This attribute was added in vSphere API 6.8.
|
||||
This attribute is None if the update session content is not signed.</p></li>
|
||||
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.PreviewWarningInfo" title="com.vmware.content.library.item.updatesession_client.PreviewWarningInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PreviewWarningInfo</span></code></a>) – The list of warnings raised for this update session. Any warning
|
||||
which is not ignored by the client will, by default, fail the
|
||||
update session during session complete operation. This attribute
|
||||
was added in vSphere API 6.8.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE" title="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PreviewInfo.State.AVAILABLE</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">PreviewInfo.State</span></code> class defines the state of the update session’s
|
||||
preview. This enumeration was added in vSphere API 6.8.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE">
|
||||
<code class="sig-name descname"><span class="pre">AVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='AVAILABLE')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Preview is available for this update session. It is possible to review
|
||||
certificate details and warnings, if any. This state is reached when the
|
||||
applicable metadata files in the session have been fully uploaded. This
|
||||
class attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.NOT_APPLICABLE">
|
||||
<code class="sig-name descname"><span class="pre">NOT_APPLICABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='NOT_APPLICABLE')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Preview is not possible for this update session. This state is reached when
|
||||
there are no metadata files in the update session and user invokes a
|
||||
session complete operation. This class attribute was added in vSphere API
|
||||
6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.PREPARING">
|
||||
<code class="sig-name descname"><span class="pre">PREPARING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='PREPARING')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.PREPARING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A preview is being prepared for the files currently in the update session.
|
||||
This state is reached when the applicable metadata files are added to the
|
||||
update session but their content is not fully uploaded yet. For OVF item
|
||||
type, this state indicates that the OVF descriptor file is currently being
|
||||
uploaded. This class attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.UNAVAILABLE">
|
||||
<code class="sig-name descname"><span class="pre">UNAVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>There are no files in the update session OR a preview is not possible for
|
||||
the files currently in the update session. However, preview may be possible
|
||||
after metadata files such as OVF descriptor are added to the session. In
|
||||
this case the state will transition to <code class="docutils literal notranslate"><span class="pre">PREPARING</span></code>. This class attribute
|
||||
was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewWarningInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.updatesession_client.</span></code><code class="sig-name descname"><span class="pre">PreviewWarningInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignored</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewWarningInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">PreviewWarningInfo</span></code> class provides information about the warnings
|
||||
which are raised during the update session preview. This class was added in
|
||||
vSphere API 6.8.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.WarningType" title="com.vmware.content.library.item.updatesession_client.WarningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">WarningType</span></code></a>) – The warning type raised during preview of the update session. This
|
||||
attribute was added in vSphere API 6.8.</p></li>
|
||||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The message specifying more details about the warning. This
|
||||
attribute was added in vSphere API 6.8.</p></li>
|
||||
<li><p><strong>ignored</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Indicates if this warning will be ignored during session complete
|
||||
operation. This attribute was added in vSphere API 6.8.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.updatesession_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningBehavior">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.updatesession_client.</span></code><code class="sig-name descname"><span class="pre">WarningBehavior</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignored</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningBehavior" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">WarningBehavior</span></code> class defines the session behavior if the warning
|
||||
is raised during the update session. This class was added in vSphere API
|
||||
6.8.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.WarningType" title="com.vmware.content.library.item.updatesession_client.WarningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">WarningType</span></code></a>) – The warning type which may be raised during the update session.
|
||||
This attribute was added in vSphere API 6.8.</p></li>
|
||||
<li><p><strong>ignored</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Indicates if this warning will be ignored during session complete
|
||||
operation. This attribute was added in vSphere API 6.8.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item.updatesession_client.</span></code><code class="sig-name descname"><span class="pre">WarningType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">WarningType</span></code> class defines the warnings which can be raised during
|
||||
the update session. This enumeration was added in vSphere API 6.8.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.content.library.item.updatesession_client.WarningType" title="com.vmware.content.library.item.updatesession_client.WarningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">WarningType</span></code></a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType.EXPIRED_CERTIFICATE">
|
||||
<code class="sig-name descname"><span class="pre">EXPIRED_CERTIFICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">WarningType(string='EXPIRED_CERTIFICATE')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.EXPIRED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The certificate used for signing the content is expired. This class
|
||||
attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType.NOT_YET_VALID_CERTIFICATE">
|
||||
<code class="sig-name descname"><span class="pre">NOT_YET_VALID_CERTIFICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">WarningType(string='NOT_YET_VALID_CERTIFICATE')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.NOT_YET_VALID_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The certificate used for signing the content is not yet valid. This class
|
||||
attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType.SELF_SIGNED_CERTIFICATE">
|
||||
<code class="sig-name descname"><span class="pre">SELF_SIGNED_CERTIFICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">WarningType(string='SELF_SIGNED_CERTIFICATE')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.SELF_SIGNED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The certificate used for signing the content is self-signed. This class
|
||||
attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType.UNTRUSTED_CERTIFICATE">
|
||||
<code class="sig-name descname"><span class="pre">UNTRUSTED_CERTIFICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">WarningType(string='UNTRUSTED_CERTIFICATE')</span></em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.UNTRUSTED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The certificate used for signing the content is not trusted. This class
|
||||
attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -190,7 +190,7 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.content.type.ovf.html">com.vmware.content.type.ovf package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.type.ovf.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.type.ovf.html#com-vmware-content-type-ovf-policy-client-module">com.vmware.content.type.ovf.policy_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.type.ovf.html#module-com.vmware.content.type.ovf.policy_client">com.vmware.content.type.ovf.policy_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -199,8 +199,390 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-content-type-ovf-client-module">
|
||||
<h2>com.vmware.content.type.ovf_client module<a class="headerlink" href="#com-vmware-content-type-ovf-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.content.type.ovf_client">
|
||||
<span id="com-vmware-content-type-ovf-client-module"></span><h2>com.vmware.content.type.ovf_client module<a class="headerlink" href="#module-com.vmware.content.type.ovf_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Cpu">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">Cpu</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_cpus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shares</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Cpu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide the CPU information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>num_cpus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – number of CPUs</p></li>
|
||||
<li><p><strong>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – reservation in MHz
|
||||
It is optional to set a CPU reservation.</p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CPU limit in MHz
|
||||
Is is optional to set a CPU limit.</p></li>
|
||||
<li><p><strong>shares</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CPU shares
|
||||
It is optional to specify CPU shares.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Disk">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">Disk</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Disk" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide the disk information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the disk</p></li>
|
||||
<li><p><strong>disk_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Capacity of the disk in megabytes</p></li>
|
||||
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="com.vmware.content.type.ovf.html#com.vmware.content.type.ovf.policy_client.StoragePolicy" title="com.vmware.content.type.ovf.policy_client.StoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.type.ovf.policy_client.StoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Storage policy of the disk.</p>
|
||||
<p>It is a reference to the storage policy group.
|
||||
It is not required that storage policy be specified.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.DiskController">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">DiskController</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sub_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.DiskController" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide the disk controller information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the disk controller</p></li>
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disk controller type: DiskControllerType.IDE.SATA.SCSI;
|
||||
It is optional to specify a disk controller type.</p></li>
|
||||
<li><p><strong>sub_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disk controller sub type: DiskControllerSubType
|
||||
It is optional to specify a disk controller subtype.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Drive">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">Drive</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sub_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Drive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide the drive information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the drive</p></li>
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Drive type
|
||||
It is optional to specify a drive type.</p></li>
|
||||
<li><p><strong>sub_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Drive sub type
|
||||
It is optional to specify a drive subtype.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Floppy">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">Floppy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Floppy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide the floppy information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the floppy</p></li>
|
||||
<li><p><strong>connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – True if floppy is connected
|
||||
It is optional to specify if a floppy is connected.</p></li>
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Floppy type
|
||||
It is optional to specify the type of floppy drive.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Memory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">Memory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shares</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Memory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide the memory information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – memory size in MB</p></li>
|
||||
<li><p><strong>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – memory reservation in MB
|
||||
It is not required that memory reservation be specified.</p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – memory limit in MB
|
||||
It is not required that memory limit be specified.</p></li>
|
||||
<li><p><strong>shares</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – memory shares
|
||||
It is not required that memory shares be specified.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Network">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">Network</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Network" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide network information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the network</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the network
|
||||
Networks do not require a description.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Nic">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">Nic</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mac_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_connected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Nic" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide NIC information in a VM template</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of NIC</p></li>
|
||||
<li><p><strong>network_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the network that this NIC connects to
|
||||
It is not required that network name be specified.</p></li>
|
||||
<li><p><strong>mac_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Mac address of this NIC
|
||||
It is not required that MAC address be specified.</p></li>
|
||||
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – True if this nic will be connected on start.
|
||||
It is not required that whether the NIC is connected be specified.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.OvfTemplate">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">OvfTemplate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">library_id_parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_vapp_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vapp_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policy_groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.OvfTemplate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provides extra information about a library item of type “ovf”.</p>
|
||||
<p>An OVF library item is the basic building block for instantiating virtual
|
||||
machines from content library. It may contain one or multiple virtual
|
||||
machine templates. This structure provides a rich view of the virtual
|
||||
machines within the ovf container as well as information about to the ovf
|
||||
descriptor associated with the library item</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Library item id.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
|
||||
this class as a return value, the attribute will be an identifier
|
||||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
|
||||
<li><p><strong>vm_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of virtual machines in the the ovf template.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>A version number indicating the generation of the <code class="docutils literal notranslate"><span class="pre">OvfTemplate</span></code></p>
|
||||
<p>This value is incremented every time <code class="docutils literal notranslate"><span class="pre">OvfTemplate</span></code> changes.</p>
|
||||
</p></li>
|
||||
<li><p><strong>library_id_parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the
|
||||
<a class="reference internal" href="com.vmware.html#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content_client.LibraryModel</span></code></a> to which this item
|
||||
belongs. This is used to set the parent of the ovf template for
|
||||
permission propagation.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p></li>
|
||||
<li><p><strong>is_vapp_template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – True if this is a vApp template, otherwise this is a VM template.</p></li>
|
||||
<li><p><strong>vm_template</strong> (<a class="reference internal" href="#com.vmware.content.type.ovf_client.VmTemplate" title="com.vmware.content.type.ovf_client.VmTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The Vitrual Machine if this is a VM template
|
||||
An OVF template does not require a VM template.</p></li>
|
||||
<li><p><strong>vapp_template</strong> (<a class="reference internal" href="#com.vmware.content.type.ovf_client.VAppTemplate" title="com.vmware.content.type.ovf_client.VAppTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">VAppTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The root VApp template in this OVF template if this is a vApp
|
||||
template
|
||||
An OVF template does not require a vApp template.</p></li>
|
||||
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Network" title="com.vmware.content.type.ovf_client.Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network</span></code></a>) – networks in this OVF template</p></li>
|
||||
<li><p><strong>storage_policy_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.content.type.ovf.html#com.vmware.content.type.ovf.policy_client.StoragePolicyGroup" title="com.vmware.content.type.ovf.policy_client.StoragePolicyGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.type.ovf.policy_client.StoragePolicyGroup</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policy groups for disks, virtual machines and/or virtual
|
||||
machine collections.
|
||||
An OVF template does not require policies.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.USBController">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">USBController</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_connect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ehci_pci_slot_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pci_slot_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.USBController" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide USB controller information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – USBControllerType.EHCI (USB 2.0), XHCI (USB 3.0)
|
||||
A template is not required to specify the USB type.</p></li>
|
||||
<li><p><strong>auto_connect</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – True if the USB controller is connected automatically
|
||||
A template is not required to specify if auto connect.</p></li>
|
||||
<li><p><strong>ehci_pci_slot_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ehci.pci slot number
|
||||
A template is not required to specify the ehci.pci slot number.</p></li>
|
||||
<li><p><strong>pci_slot_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – pci slot number
|
||||
A template is not required to specify the pci slot number.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.VAppTemplate">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">VAppTemplate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vapp_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_templates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.VAppTemplate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide information for vApp template in an OVF template file.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vapp_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the vApp template
|
||||
vApp templates do not require a name.</p></li>
|
||||
<li><p><strong>vm_templates</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.VmTemplate" title="com.vmware.content.type.ovf_client.VmTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Vitrual Machines in this vApp template
|
||||
vApp templates do not require a list of VM templates.</p></li>
|
||||
<li><p><strong>storage_policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.content.type.ovf.html#com.vmware.content.type.ovf.policy_client.StoragePolicy" title="com.vmware.content.type.ovf.policy_client.StoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.type.ovf.policy_client.StoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policies of the vApp template.
|
||||
vApp templates do not require a list of storage policies.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.VideoCard">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">VideoCard</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">render_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">video_ram_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">graphics_memory_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable3d</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_displays</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_auto_detect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.VideoCard" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide video card information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>render_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Render type
|
||||
A template is not required to specify the render type.</p></li>
|
||||
<li><p><strong>video_ram_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – video RAM size in KB
|
||||
A template is not required to specify the video RAM.</p></li>
|
||||
<li><p><strong>graphics_memory_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – graphics memory size in KB
|
||||
A template is not required to specify the amount of graphics
|
||||
memory.</p></li>
|
||||
<li><p><strong>enable3d</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – True if 3D is enabled
|
||||
A template is not required to specify if 3D is enabled.</p></li>
|
||||
<li><p><strong>num_displays</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – number of displayes
|
||||
A template is not required to specify the number of displays.</p></li>
|
||||
<li><p><strong>use_auto_detect</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – True if use auto detect
|
||||
A template is not required to specify use auto dectect.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf_client.VmTemplate">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf_client.</span></code><code class="sig-name descname"><span class="pre">VmTemplate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">os_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">os_description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">video_cards</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drives</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">floppies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_controllers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usb_controllers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.VmTemplate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide template VM information in an OVF template (see OvfTemplate#type).
|
||||
The template VM provide the information about the operation system, CPU,
|
||||
memory, disks and NICs.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the VM</p></li>
|
||||
<li><p><strong>os_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – OS type of the VM
|
||||
A VM template is not required to specify an OS.</p></li>
|
||||
<li><p><strong>os_description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – OS description
|
||||
A VM template is not required to specify an OS.</p></li>
|
||||
<li><p><strong>cpu</strong> (<a class="reference internal" href="#com.vmware.content.type.ovf_client.Cpu" title="com.vmware.content.type.ovf_client.Cpu"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cpu</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CPU information of the VM
|
||||
A VM template is not required to specify a CPU.</p></li>
|
||||
<li><p><strong>memory</strong> (<a class="reference internal" href="#com.vmware.content.type.ovf_client.Memory" title="com.vmware.content.type.ovf_client.Memory"><code class="xref py py-class docutils literal notranslate"><span class="pre">Memory</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – memory information of the VM
|
||||
A VM template is not required to specify memory.</p></li>
|
||||
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Disk" title="com.vmware.content.type.ovf_client.Disk"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – All hard disks on the VM
|
||||
A VM template is not required to specify a list of disks.</p></li>
|
||||
<li><p><strong>nics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Nic" title="com.vmware.content.type.ovf_client.Nic"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – All NICs on the VM
|
||||
A VM template is not required to specify a list of network
|
||||
interfaces.</p></li>
|
||||
<li><p><strong>video_cards</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.VideoCard" title="com.vmware.content.type.ovf_client.VideoCard"><code class="xref py py-class docutils literal notranslate"><span class="pre">VideoCard</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Video cards of the VM
|
||||
A VM template is not required to specify a list of video cards.</p></li>
|
||||
<li><p><strong>drives</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Drive" title="com.vmware.content.type.ovf_client.Drive"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drive</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CD / DVD drives of the VM
|
||||
A VM template is not required to specify a list of drives.</p></li>
|
||||
<li><p><strong>floppies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Floppy" title="com.vmware.content.type.ovf_client.Floppy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – floppy drives of the VM
|
||||
A VM template is not required to specify a list of floppy drives.</p></li>
|
||||
<li><p><strong>disk_controllers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.DiskController" title="com.vmware.content.type.ovf_client.DiskController"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskController</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disk Controllers
|
||||
A VM template is not required to specify a list of disk
|
||||
controllers.</p></li>
|
||||
<li><p><strong>usb_controllers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.USBController" title="com.vmware.content.type.ovf_client.USBController"><code class="xref py py-class docutils literal notranslate"><span class="pre">USBController</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – USB Controllers
|
||||
A VM template is not required to specify a list of USB controllers.</p></li>
|
||||
<li><p><strong>storage_policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.content.type.ovf.html#com.vmware.content.type.ovf.policy_client.StoragePolicy" title="com.vmware.content.type.ovf.policy_client.StoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.type.ovf.policy_client.StoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policies of the VM.
|
||||
A VM template is not required to specify a list of storage
|
||||
policies.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,8 +189,61 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-content-type-ovf-policy-client-module">
|
||||
<h2>com.vmware.content.type.ovf.policy_client module<a class="headerlink" href="#com-vmware-content-type-ovf-policy-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.content.type.ovf.policy_client">
|
||||
<span id="com-vmware-content-type-ovf-policy-client-module"></span><h2>com.vmware.content.type.ovf.policy_client module<a class="headerlink" href="#module-com.vmware.content.type.ovf.policy_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf.policy_client.StoragePolicy">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf.policy_client.</span></code><code class="sig-name descname"><span class="pre">StoragePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf.policy_client.StoragePolicy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide information of the membership of a particular storage policy group.</p>
|
||||
<p>It is valid for disk, virtual machine or virtual machine collection.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id reference of the particular storage policy group.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf.policy_client.StoragePolicyGroup">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf.policy_client.</span></code><code class="sig-name descname"><span class="pre">StoragePolicyGroup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf.policy_client.StoragePolicyGroup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provide information of storage policy for a group of disks, virtual
|
||||
machines and/or virtual machine collections.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the policy</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the policy
|
||||
Description is not required.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.content.type.ovf.policy_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.type.ovf.policy_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf.policy_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -187,8 +187,458 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-hcl-hosts-client-module">
|
||||
<h2>com.vmware.esx.hcl.hosts_client module<a class="headerlink" href="#com-vmware-esx-hcl-hosts-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.hcl.hosts_client">
|
||||
<span id="com-vmware-esx-hcl-hosts-client-module"></span><h2>com.vmware.esx.hcl.hosts_client module<a class="headerlink" href="#module-com.vmware.esx.hcl.hosts_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReleases">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.hcl.hosts_client.</span></code><code class="sig-name descname"><span class="pre">CompatibilityReleases</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>This class provides methods to list available releases for generating
|
||||
compatibility report for a specific ESXi host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReleases.EsxiCompatibilityReleases">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EsxiCompatibilityReleases</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_compatibility_release</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newer_compatibility_releases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases.EsxiCompatibilityReleases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReleases.EsxiCompatibilityReleases</span></code> class contains
|
||||
attributes that describe available releases for generating compatibility
|
||||
report for a specific ESXi host.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>current_compatibility_release</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The current release of the ESXi, which also can be checked for
|
||||
compatibility.</p>
|
||||
<p>The information for the release does not include patch information.</p>
|
||||
</p></li>
|
||||
<li><p><strong>newer_compatibility_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The available ESXi releases, greater than the current one, than can
|
||||
be checked for compatibility.</p></li>
|
||||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Notifications" title="com.vmware.esx.hcl_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Notifications</span></code></a>) – Notifications returned by the operation.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReleases.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists the locally available ESXi releases for a given host that can be
|
||||
used to generate a compatiblity report. Each host has its own list of
|
||||
supported releases depending on its current release.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Contains the MoID identifying the ESXi host.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases.EsxiCompatibilityReleases" title="com.vmware.esx.hcl.hosts_client.CompatibilityReleases.EsxiCompatibilityReleases"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReleases.EsxiCompatibilityReleases</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Available releases for compatibility for a specified host.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
|
||||
If there is some internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if there is no compatibility data on the vCenter executing the
|
||||
operation.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if no host with the given MoID can be found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
if the provided host is not supported.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||||
if the vCenter this API is executed on is not part of the Customer
|
||||
Experience Improvement Program (CEIP).</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown error. The accompanying error message will
|
||||
give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.HardwareCompatibility.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.hcl.hosts_client.</span></code><code class="sig-name descname"><span class="pre">CompatibilityReport</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>This class provides methods to generate hardware compatibility report for a
|
||||
given ESXi host against a specific ESXi release.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.BiosConstraint">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">BiosConstraint</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bios</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.BiosConstraint" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.BiosConstraint</span></code> class contains attributes that
|
||||
describe the BIOS that is supported for the given server and ESXi release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>bios</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Firmware" title="com.vmware.esx.hcl_client.Firmware"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Firmware</span></code></a>) – The BIOS information about the constraint.</p></li>
|
||||
<li><p><strong>notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Any information that should be taken into account when reviewing
|
||||
the BIOS constraint.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceConstraint">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeviceConstraint</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">driver</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">firmware</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceConstraint" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.DeviceConstraint</span></code> class contains attributes
|
||||
that describe pair of driver and firmware that are supported for a given
|
||||
PCI device and ESXi release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>driver</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Driver" title="com.vmware.esx.hcl_client.Driver"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Driver</span></code></a>) – The driver information about the constraint.</p></li>
|
||||
<li><p><strong>firmware</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Firmware" title="com.vmware.esx.hcl_client.Firmware"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Firmware</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The firmware information about the constraint.
|
||||
If None there is no firmware restriction on the driver to work with
|
||||
that release.</p></li>
|
||||
<li><p><strong>notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Any information that should be taken into account when reviewing
|
||||
the device constraint.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceHclInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeviceHclInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compatibility</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_releases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vcg_link</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceHclInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.DeviceHclInfo</span></code> class contains attributes that
|
||||
describe a PCI device of a given ESXi host and its compatibility
|
||||
information.</p>
|
||||
<p>If there are multiple PCI devices of the same type on the host each one
|
||||
will be listed in separate instance of this class.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>compatibility</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.CompatibilityStatus" title="com.vmware.esx.hcl_client.CompatibilityStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.CompatibilityStatus</span></code></a>) – Indicates compatibility status of the PCI device.</p></li>
|
||||
<li><p><strong>device</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.PCIDevice" title="com.vmware.esx.hcl_client.PCIDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.PCIDevice</span></code></a>) – Information about the PCI device.</p></li>
|
||||
<li><p><strong>device_constraints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceConstraint" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceConstraint"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.DeviceConstraint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists the constraints the target ESXi release has for this PCI
|
||||
device
|
||||
If None no constraints are present as PCI device is either not
|
||||
compatible or compatibility information is not found.</p></li>
|
||||
<li><p><strong>supported_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provides information about supported releases for this device.
|
||||
If None device is compatible with the given target release.</p></li>
|
||||
<li><p><strong>vcg_link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provides link to the VMware Compatibility Guide for further
|
||||
information on the compatibility.
|
||||
If None there is no VMware Compatibility link available as this is
|
||||
device used by VSAN.</p></li>
|
||||
<li><p><strong>notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information that needs to be taken into account when considering
|
||||
this device hcl.
|
||||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there is any information reported.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.HclReport">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">HclReport</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_release</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_hcl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">devices_hcl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">generated_at</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.HclReport" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.HclReport</span></code> represents the hardware
|
||||
compatibility report generated for a specific host and target ESXi release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – FQDN identifying the ESXi host that the report refers to.</p></li>
|
||||
<li><p><strong>target_release</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Indicates for which ESXi release the report is generated.</p></li>
|
||||
<li><p><strong>server_hcl</strong> (<a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerHclInfo" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerHclInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.ServerHclInfo</span></code></a>) – Lists compatibility information for the ESXi’s server part.</p></li>
|
||||
<li><p><strong>devices_hcl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceHclInfo" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceHclInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.DeviceHclInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists compatibility information for discoverable PCI devices of the
|
||||
host.
|
||||
If None the server is not compatible with the requested release and
|
||||
the PCI devices cannot be checked.</p></li>
|
||||
<li><p><strong>generated_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Specifies the time the report was generated.</p></li>
|
||||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Notifications" title="com.vmware.esx.hcl_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Notifications</span></code></a>) – Notifications returned by the operation.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.Result">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Result</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">report</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">identifier</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.Result" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.Result</span></code> class contains the result of hardware
|
||||
compatibility report creation operation.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>report</strong> (<a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.HclReport" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.HclReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.HclReport</span></code></a>) – The hardware compatibility report.</p></li>
|
||||
<li><p><strong>identifier</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The identifier of the compatibility report.</p>
|
||||
<p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Reports.get" title="com.vmware.esx.hcl_client.Reports.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Reports.get()</span></code></a> provides location
|
||||
where a file based report based on the
|
||||
<code class="docutils literal notranslate"><span class="pre">CompatibilityReport.HclReport</span></code> can be downloaded using this
|
||||
identifier.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.hcl.resources.CompatibilityReport</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.hcl.resources.CompatibilityReport</span></code>.
|
||||
None in case of error reported in
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CompatibilityReport.HclReport.notifications</span></code>.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerCompatibility">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ServerCompatibility</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bios_constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_series</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_releases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vcg_link</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerCompatibility" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.ServerCompatibility</span></code> class contains attributes
|
||||
that provide the compatibility information for a server model, cpu and
|
||||
BIOS.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>bios_constraints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.BiosConstraint" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.BiosConstraint"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.BiosConstraint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists the BIOS constraints that the target ESXi release has for
|
||||
this server.
|
||||
If None no constraints are present as server is either not
|
||||
compatible or compatibility information is not found.</p></li>
|
||||
<li><p><strong>cpu_series</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The CPU series name.</p></li>
|
||||
<li><p><strong>supported_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provides information about supported releases for this entry.
|
||||
If None server is compatible with the given target release.</p></li>
|
||||
<li><p><strong>vcg_link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provides link to the VMware Compatibility Guide for further
|
||||
information on the compatibility.</p></li>
|
||||
<li><p><strong>notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information that needs to be taken into account when considering
|
||||
this server hardware compatibility.
|
||||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there is any information reported.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerHclInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ServerHclInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">matches</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model_compatibility</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerHclInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.ServerHclInfo</span></code> class contains attributes that
|
||||
describe the server of a ESXi host and its compatibility information.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>server</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Server" title="com.vmware.esx.hcl_client.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Server</span></code></a>) – Information about the server.</p></li>
|
||||
<li><p><strong>matches</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerCompatibility" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerCompatibility"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.ServerCompatibility</span></code></a>) – <p>Provides information about possible compatibility matches for the
|
||||
given server.</p>
|
||||
<p>There could be multiple matches returned as there are several
|
||||
possible matches in the Compatibility data.</p>
|
||||
</p></li>
|
||||
<li><p><strong>model_compatibility</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.CompatibilityStatus" title="com.vmware.esx.hcl_client.CompatibilityStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.CompatibilityStatus</span></code></a>) – Shows if the server model is compatible with given target ESXi
|
||||
release.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.Spec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">release</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.Spec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.Spec</span></code> class contains attributes to describe the
|
||||
input configuration for an ESXi’s compatibility report generation.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>release</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A target ESXi release which will be used to generate a
|
||||
compatibility report. Releases that can be used to generate report
|
||||
can be found using <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases.list" title="com.vmware.esx.hcl.hosts_client.CompatibilityReleases.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">CompatibilityReleases.list()</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.create_task">
|
||||
<code class="sig-name descname"><span class="pre">create_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.create_task" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generates hardware compatibility report for a specified ESXi host
|
||||
against specific ESXi release.</p>
|
||||
<p>The result of this operation can be queried by calling the
|
||||
cis/tasks/{task-id} where the task-id is the response of this
|
||||
operation.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Contains the MoID identifying the ESXi host.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.Spec" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.Spec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies the input parameters for generating compatibility report.
|
||||
If None host compatibility will be checked against the current
|
||||
release of the ESXi.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><dl class="field-list simple">
|
||||
<dt class="field-odd">class</dt>
|
||||
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Task instance</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if no host with the given MoID can be found.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
if the provided host is not supported.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||||
if the vCenter this API is executed on is not part of the Customer
|
||||
Experience Improvement Program (CEIP).</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if there is no compatibility data on the vCenter executing the
|
||||
operation.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown error. The accompanying error message will
|
||||
give more details about the failure.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the last generated hardware compatibility report for the given
|
||||
host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.Result" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.Result"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.Result</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p></p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if there is no report generated for the given host. This operation
|
||||
does not check if the host id is valid or it exists.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||||
if the vCenter this API is executed on is not part of the Customer
|
||||
Experience Improvement Program (CEIP).</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown error. The accompanying error message will
|
||||
give more details about the failure.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hcl.hosts_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.hcl.hosts_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,8 +189,22 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-hosts-health-perspectives-client-module">
|
||||
<h2>com.vmware.esx.hosts.health.perspectives_client module<a class="headerlink" href="#com-vmware-esx-hosts-health-perspectives-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.hosts.health.perspectives_client">
|
||||
<span id="com-vmware-esx-hosts-health-perspectives-client-module"></span><h2>com.vmware.esx.hosts.health.perspectives_client module<a class="headerlink" href="#module-com.vmware.esx.hosts.health.perspectives_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.hosts.health.perspectives_client</span></code> module provides classes
|
||||
to get the health status of ESX hosts relevant to a specific perspective.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hosts.health.perspectives_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.hosts.health.perspectives_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts.health.perspectives_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -190,7 +190,7 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.hosts.health.html">com.vmware.esx.hosts.health package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.hosts.health.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.hosts.health.html#com-vmware-esx-hosts-health-perspectives-client-module">com.vmware.esx.hosts.health.perspectives_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.hosts.health.html#module-com.vmware.esx.hosts.health.perspectives_client">com.vmware.esx.hosts.health.perspectives_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -199,8 +199,105 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-hosts-software-client-module">
|
||||
<h2>com.vmware.esx.hosts.software_client module<a class="headerlink" href="#com-vmware-esx-hosts-software-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.hosts.software_client">
|
||||
<span id="com-vmware-esx-hosts-software-client-module"></span><h2>com.vmware.esx.hosts.software_client module<a class="headerlink" href="#module-com.vmware.esx.hosts.software_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.hosts.software_client</span></code> module provides classes to get
|
||||
information about current software on ESX.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hosts.software_client.InstalledComponents">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.hosts.software_client.</span></code><code class="sig-name descname"><span class="pre">InstalledComponents</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts.software_client.InstalledComponents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">InstalledComponents</span></code> class provides methods to get installed list of
|
||||
components.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hosts.software_client.InstalledComponents.InstalledComponentInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">InstalledComponentInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts.software_client.InstalledComponents.InstalledComponentInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">InstalledComponents.InstalledComponentInfo</span></code> class contains
|
||||
attributes that describe the installed component on the host.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the component.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the installed component</p></li>
|
||||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the component.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.hosts.software_client.InstalledComponents.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts.software_client.InstalledComponents.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the installed components on the host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.hosts.software_client.InstalledComponents.InstalledComponentInfo" title="com.vmware.esx.hosts.software_client.InstalledComponents.InstalledComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstalledComponents.InstalledComponentInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The components installed on the host.
|
||||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.hosts.component</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
|
||||
requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.hosts.software_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.hosts.software_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts.software_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -191,8 +191,234 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-clusters-policies-apply-client-module">
|
||||
<h2>com.vmware.esx.settings.clusters.policies.apply_client module<a class="headerlink" href="#com-vmware-esx-settings-clusters-policies-apply-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.clusters.policies.apply_client">
|
||||
<span id="com-vmware-esx-settings-clusters-policies-apply-client-module"></span><h2>com.vmware.esx.settings.clusters.policies.apply_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.policies.apply_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.policies.apply_client</span></code> module provides
|
||||
classes to manage policies that affect application of desired state
|
||||
configuration and software for an ESXi cluster. Copyright 2019-2020 VMware,
|
||||
Inc. All rights reserved. VMware Confidential Copyright 2019-2020 VMware, Inc.
|
||||
All rights reserved. VMware Confidential</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.policies.apply_client.</span></code><code class="sig-name descname"><span class="pre">Effective</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective</span></code> class provides methods to manage the effective policies
|
||||
that will impact how the software and configuration specification documents
|
||||
are applied to an ESXi cluster.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EffectivePolicySpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failure_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pre_remediation_power_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable_quick_boot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_dpm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_hac</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evacuate_offline_vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_hcl_validation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec</span></code> class contains attributes that
|
||||
describe the effective policies to be used when the software and
|
||||
configuration specification documents are applied to an ESXi cluster.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>failure_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.FailureAction</span></code></a>) – What action is to be taken if entering maintenance mode fails on a
|
||||
given host of the cluster.</p></li>
|
||||
<li><p><strong>pre_remediation_power_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction</span></code></a>) – Specifies what should be done to the power state of the VM before
|
||||
entering maintenance mode.</p></li>
|
||||
<li><p><strong>enable_quick_boot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enable Quick Boot during remediation in the cluster.</p></li>
|
||||
<li><p><strong>disable_dpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Disable DPM on the cluster.</p></li>
|
||||
<li><p><strong>disable_hac</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Disable HA Admission control on the cluster.</p></li>
|
||||
<li><p><strong>evacuate_offline_vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Evacuate powered off/suspended VMs when attempting maintenance
|
||||
mode.</p></li>
|
||||
<li><p><strong>enforce_hcl_validation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enforce Hcl validation, when applicable, to prevent remediation if
|
||||
hardware compatibility issues are found. This attribute was added
|
||||
in vSphere API 7.0.1.0.
|
||||
This attribute is optional because it was added in a newer version
|
||||
than its parent node.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PreRemediationPowerAction</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction</span></code> class
|
||||
defines the possible actions to be taken, before entering maintenance mode.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">PreRemediationPowerAction</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE">
|
||||
<code class="sig-name descname"><span class="pre">DO_NOT_CHANGE_VMS_POWER_STATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not change the VM power state</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS">
|
||||
<code class="sig-name descname"><span class="pre">POWER_OFF_VMS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='POWER_OFF_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Power off VMs before entering maintenance mode.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS">
|
||||
<code class="sig-name descname"><span class="pre">SUSPEND_VMS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Suspend VMs before entering maintenance mode</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY">
|
||||
<code class="sig-name descname"><span class="pre">SUSPEND_VMS_TO_MEMORY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Suspend VMs to Memory before entering maintenance mode. This class
|
||||
attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FailureAction</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.FailureAction</span></code> class contains attributes that describe the
|
||||
actions to be taken when entering maintenance mode fails on a single host
|
||||
within the cluster.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.FailureAction.Action</span></code></a>) – What action (FAIL, RETRY) is to be taken if entering maintenance
|
||||
mode fails on a single host within the cluster.</p></li>
|
||||
<li><p><strong>retry_delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time to wait to retry the failed operation in seconds.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Effective.FailureAction.Action.RETRY</span></code></a>.</p></li>
|
||||
<li><p><strong>retry_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of times to retry the failed operation.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Effective.FailureAction.Action.RETRY</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Action</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.FailureAction.Action</span></code> class defines the actions to be
|
||||
taken when entering maintenance mode fails on a single host within the
|
||||
cluster.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Action</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.FAIL">
|
||||
<code class="sig-name descname"><span class="pre">FAIL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Action(string='FAIL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.FAIL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail the apply method</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY">
|
||||
<code class="sig-name descname"><span class="pre">RETRY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Action(string='RETRY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retry the task Apply.FailureAction#retryCount number of times on the failed
|
||||
host after Apply.FailureAction#retryDelay.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the effective apply policy based on system defaults and what
|
||||
has been configured for the cluster.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The effective policies that impact the apply method on this
|
||||
cluster.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is an unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.policies.apply_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -193,8 +193,878 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-clusters-software-drafts-software-client-module">
|
||||
<h2>com.vmware.esx.settings.clusters.software.drafts.software_client module<a class="headerlink" href="#com-vmware-esx-settings-clusters-software-drafts-software-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.clusters.software.drafts.software_client">
|
||||
<span id="com-vmware-esx-settings-clusters-software-drafts-software-client-module"></span><h2>com.vmware.esx.settings.clusters.software.drafts.software_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software.drafts.software_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client</span></code> module
|
||||
provides classes to manage draft of the software documents for ESX cluster.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></code><code class="sig-name descname"><span class="pre">AddOn</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AddOn</span></code> class provides methods to manage the OEM add-on specification
|
||||
in a software draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.RESOURCE_TYPE">
|
||||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.esx.settings.add_on'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for add-on resource</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes the desired OEM add-on specification in the software draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the OEM add-on specification in a software draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.AddOnInfo" title="com.vmware.esx.settings_client.AddOnInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.AddOnInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>OEM add-on specification.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system or no add-on specification
|
||||
is set.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.set">
|
||||
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets a new desired OEM add-on specification in the software draft. It
|
||||
will overwrite the existing desired OEM add-on specification if one
|
||||
already exists.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.AddOnSpec" title="com.vmware.esx.settings_client.AddOnSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.AddOnSpec</span></code></a>) – AddOn specification.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></code><code class="sig-name descname"><span class="pre">BaseImage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">BaseImage</span></code> class provides methods to manage the base-image
|
||||
specification in a software draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.RESOURCE_TYPE">
|
||||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.esx.settings.base_image'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for base-image resource</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the base-image specification in a software draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.BaseImageInfo" title="com.vmware.esx.settings_client.BaseImageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.BaseImageInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Base-image specification.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.set">
|
||||
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets a new desired base-image specification in the software draft. It
|
||||
will overwrite the existing desired base-image specification if one
|
||||
already exists.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.BaseImageSpec" title="com.vmware.esx.settings_client.BaseImageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.BaseImageSpec</span></code></a>) – Base-image specification.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></code><code class="sig-name descname"><span class="pre">Components</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Components</span></code> class provides methods to manage component specification
|
||||
in a software draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.RESOURCE_TYPE">
|
||||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.esx.settings.component'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for component resource</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">components_to_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">components_to_delete</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Components.UpdateSpec</span></code> class contains attributes that are specified
|
||||
to update list of components in the draft.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>components_to_set</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>)) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of components to be updated. If the component already exists
|
||||
in the draft, the version is updated, else it is added. If a
|
||||
component is provided without version, then its version will be
|
||||
chosen based on constraints in the system.
|
||||
When clients pass a value of this class as a parameter, the key in
|
||||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>. When methods return a
|
||||
value of this class as a return value, the key in the attribute
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.
|
||||
If None, no components will be added or updated.</p></li>
|
||||
<li><p><strong>components_to_delete</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of components to be removed.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will contain
|
||||
identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.
|
||||
If None, no components will be removed.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes the given component from the software draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the component version for the given component in the software
|
||||
draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about component version.
|
||||
If None then version will be chosen based on the constraints in the
|
||||
system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> or no component associated with
|
||||
<code class="docutils literal notranslate"><span class="pre">component</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the components that comprise the software draft.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Map of component version information keyed by the component
|
||||
identifier.
|
||||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
If the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.set">
|
||||
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the component version for a given component in the software draft.
|
||||
This will overwrite any existing version for the given component.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component version.
|
||||
This attribute is currently required. In the future,if this
|
||||
attribute is None then version is chosen based on the constraints
|
||||
in the system.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
If the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.update">
|
||||
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Updates the list of components in a given draft. This allows set and/or
|
||||
delete of multiple components in a batch operation.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec" title="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.UpdateSpec</span></code></a>) – Update specification containing list of components to add and/or
|
||||
delete.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
If the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></code><code class="sig-name descname"><span class="pre">EffectiveComponents</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">EffectiveComponents</span></code> class provides methods to manage effective list
|
||||
of components.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the components that comprise the desired software state of the
|
||||
cluster.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.EffectiveComponentInfo" title="com.vmware.esx.settings_client.EffectiveComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.EffectiveComponentInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Map of effective components keyed by their identifier.
|
||||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
If the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></code><code class="sig-name descname"><span class="pre">HardwareSupport</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">HardwareSupport</span></code> class provides methods to manage a cluster’s
|
||||
Hardware Support Package (HSP) configuration in working copy documents.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes a given cluster’s working copy document Hardware Support
|
||||
Package (HSP) configuration.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of image working copy document being updated
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster named <code class="docutils literal notranslate"><span class="pre">cluster</span></code>, no working copy document
|
||||
<code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system, or no Hardware Support Package (HSP)
|
||||
configured as part of the working copy document.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a given cluster’s working copy document Hardware Support
|
||||
Package (HSP) configuration.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of image working copy document being updated
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HardwareSupportInfo" title="com.vmware.esx.settings_client.HardwareSupportInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HardwareSupportInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Hardware Support Package (HSP) configured for use</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster named <code class="docutils literal notranslate"><span class="pre">cluster</span></code>, no working copy document
|
||||
<code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system, or no Hardware Support Package (HSP)
|
||||
configured as part of the working copy document.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.set">
|
||||
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Replaces a given cluster’s working copy document Hardware Support
|
||||
Package (HSP) configuration.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of image working copy document being updated
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HardwareSupportSpec" title="com.vmware.esx.settings_client.HardwareSupportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HardwareSupportSpec</span></code></a>) – new Hardware Support Package (HSP) configuration for the cluster</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster named <code class="docutils literal notranslate"><span class="pre">cluster</span></code>, no working copy document
|
||||
<code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system, or no Hardware Support Package (HSP)
|
||||
configured as part of the working copy document.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.drafts.software_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -193,8 +193,86 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-clusters-software-reports-hardware-compatibility-client-module">
|
||||
<h2>com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client module<a class="headerlink" href="#com-vmware-esx-settings-clusters-software-reports-hardware-compatibility-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client">
|
||||
<span id="com-vmware-esx-settings-clusters-software-reports-hardware-compatibility-client-module"></span><h2>com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client</span></code>
|
||||
module provides classes to manage reports pertaining to the desired state
|
||||
software for a cluster of ESXi hosts.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.</span></code><code class="sig-name descname"><span class="pre">Details</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details</span></code> class provides methods to retrieve selected results from a
|
||||
previously initiated HCL compliance scan.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the HCL validation check detailed results.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the cluster.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.CheckResult" title="com.vmware.esx.settings.clusters.software.reports_client.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.CheckResult</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>CheckResult HCL validation result.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some other unknown internal error. The accompanying
|
||||
error message will give more details about the failure and any
|
||||
possible resolution(s).</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
|
||||
if desired software document is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.HardwareCompatibility.Read</span></code>.</p></li>
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.HardwareCompatibility.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -194,7 +194,7 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html">com.vmware.esx.settings.defaults.clusters.policies package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#com-vmware-esx-settings-defaults-clusters-policies-apply-client-module">com.vmware.esx.settings.defaults.clusters.policies.apply_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#module-com.vmware.esx.settings.defaults.clusters.policies.apply_client">com.vmware.esx.settings.defaults.clusters.policies.apply_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -203,8 +203,257 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-defaults-clusters-policies-client-module">
|
||||
<h2>com.vmware.esx.settings.defaults.clusters.policies_client module<a class="headerlink" href="#com-vmware-esx-settings-defaults-clusters-policies-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.defaults.clusters.policies_client">
|
||||
<span id="com-vmware-esx-settings-defaults-clusters-policies-client-module"></span><h2>com.vmware.esx.settings.defaults.clusters.policies_client module<a class="headerlink" href="#module-com.vmware.esx.settings.defaults.clusters.policies_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Copyright 2019-2020 VMware, Inc. All rights reserved. VMware Confidential</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.defaults.clusters.policies_client.</span></code><code class="sig-name descname"><span class="pre">Apply</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Apply</span></code> class provides methods to configure the policies that will
|
||||
impact how the software and configuration specification documents are
|
||||
applied to ESXi clusters.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfiguredPolicySpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failure_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pre_remediation_power_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable_quick_boot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_dpm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_hac</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evacuate_offline_vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_hcl_validation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec</span></code> class contains attributes that describe
|
||||
the policies configured to be used when the software and configuration
|
||||
specification documents are applied to ESXi clusters.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>failure_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction" title="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.FailureAction</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – What action is to be taken if entering maintenance mode fails on a
|
||||
given host of the cluster.
|
||||
If None, configured value would be unset.</p></li>
|
||||
<li><p><strong>pre_remediation_power_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction" title="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec.PreRemediationPowerAction</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies what should be done to the power state of the VM before
|
||||
entering maintenance mode.
|
||||
If None, configured value would be unset.</p></li>
|
||||
<li><p><strong>enable_quick_boot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable Quick Boot during remediation in the cluster.
|
||||
If None, configured value would be unset.</p></li>
|
||||
<li><p><strong>disable_dpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disable DPM on the cluster.
|
||||
If None, configured value would be unset.</p></li>
|
||||
<li><p><strong>disable_hac</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disable HA Admission control on the cluster.
|
||||
If None, configured value would be unset.</p></li>
|
||||
<li><p><strong>evacuate_offline_vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Evacuate powered off/suspended VMs when attempting maintenance
|
||||
mode.
|
||||
If None, configured value would be unset.</p></li>
|
||||
<li><p><strong>enforce_hcl_validation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enforce Hcl validation, when applicable, to prevent remediation if
|
||||
hardware compatibility issues are found. This attribute was added
|
||||
in vSphere API 7.0.1.0.
|
||||
If None, hardware compatibility issues will not prevent
|
||||
remediation.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PreRemediationPowerAction</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec.PreRemediationPowerAction</span></code> class defines
|
||||
the possible actions to be taken on VMs before entering maintenance mode.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">PreRemediationPowerAction</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE">
|
||||
<code class="sig-name descname"><span class="pre">DO_NOT_CHANGE_VMS_POWER_STATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not change the VM power state</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.POWER_OFF_VMS">
|
||||
<code class="sig-name descname"><span class="pre">POWER_OFF_VMS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='POWER_OFF_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.POWER_OFF_VMS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Power off VMs before entering maintenance mode.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS">
|
||||
<code class="sig-name descname"><span class="pre">SUSPEND_VMS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Suspend VMs before entering maintenance mode</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY">
|
||||
<code class="sig-name descname"><span class="pre">SUSPEND_VMS_TO_MEMORY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Suspend VMs to Memory before entering maintenance mode. This class
|
||||
attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FailureAction</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Apply.FailureAction</span></code> class contains attributes that describe the
|
||||
actions to be taken when entering maintenance mode fails on a single host
|
||||
within the cluster.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action" title="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.FailureAction.Action</span></code></a>) – What action (FAIL, RETRY) is to be taken if entering maintenance
|
||||
mode fails on a single host within the cluster.</p></li>
|
||||
<li><p><strong>retry_delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time to wait to retry the failed operation in seconds.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action.RETRY" title="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.FailureAction.Action.RETRY</span></code></a>.</p></li>
|
||||
<li><p><strong>retry_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of times to retry the failed operation.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action.RETRY" title="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.FailureAction.Action.RETRY</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Action</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Apply.FailureAction.Action</span></code> class defines the actions to be taken
|
||||
when entering maintenance mode fails on a single host within the cluster.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Action</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action.FAIL">
|
||||
<code class="sig-name descname"><span class="pre">FAIL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Action(string='FAIL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action.FAIL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail the apply method</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action.RETRY">
|
||||
<code class="sig-name descname"><span class="pre">RETRY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Action(string='RETRY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action.RETRY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retry the task <code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.FailureAction.retry_count</span></code> number of times on
|
||||
the failed host after <code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.FailureAction.retry_delay</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the configured policy that has been set.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec" title="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>The configured policies that impact the apply method</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is an unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.set">
|
||||
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This API will set the configured policy specification.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec" title="com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec</span></code></a>) – The policy that needs to be configured.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is an unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
If invalid value is provided.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
If the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires
|
||||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Write</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.defaults.clusters.policies_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -193,8 +193,221 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-defaults-clusters-policies-apply-client-module">
|
||||
<h2>com.vmware.esx.settings.defaults.clusters.policies.apply_client module<a class="headerlink" href="#com-vmware-esx-settings-defaults-clusters-policies-apply-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.defaults.clusters.policies.apply_client">
|
||||
<span id="com-vmware-esx-settings-defaults-clusters-policies-apply-client-module"></span><h2>com.vmware.esx.settings.defaults.clusters.policies.apply_client module<a class="headerlink" href="#module-com.vmware.esx.settings.defaults.clusters.policies.apply_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.defaults.clusters.policies.apply_client</span></code> module
|
||||
provides classes to manage policies that affect application of desired state
|
||||
configuration and software for ESXi clusters. Copyright 2019-2020 VMware, Inc.
|
||||
All rights reserved. VMware Confidential Copyright 2019-2020 VMware, Inc. All
|
||||
rights reserved. VMware Confidential</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.defaults.clusters.policies.apply_client.</span></code><code class="sig-name descname"><span class="pre">Effective</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective</span></code> class provides methods to manage the effective policies
|
||||
that will impact how the software and configuration specification documents
|
||||
are applied to ESXi clusters.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EffectivePolicySpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failure_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pre_remediation_power_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable_quick_boot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_dpm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_hac</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evacuate_offline_vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_hcl_validation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec</span></code> class contains attributes that
|
||||
describe the effective policies to be used when the software and
|
||||
configuration specification documents are applied to ESXi clusters.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>failure_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction" title="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.FailureAction</span></code></a>) – What action is to be taken if entering maintenance mode fails on a
|
||||
given host of the cluster.</p></li>
|
||||
<li><p><strong>pre_remediation_power_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction" title="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction</span></code></a>) – Specifies what should be done to the power state of the VM before
|
||||
entering maintenance mode.</p></li>
|
||||
<li><p><strong>enable_quick_boot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enable Quick Boot during remediation in the cluster.</p></li>
|
||||
<li><p><strong>disable_dpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Disable DPM on the cluster.</p></li>
|
||||
<li><p><strong>disable_hac</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Disable HA Admission control on the cluster.</p></li>
|
||||
<li><p><strong>evacuate_offline_vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Evacuate powered off/suspended VMs when attempting maintenance
|
||||
mode.</p></li>
|
||||
<li><p><strong>enforce_hcl_validation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enforce Hcl validation, when applicable, to prevent remediation if
|
||||
hardware compatibility issues are found. This attribute was added
|
||||
in vSphere API 7.0.1.0.
|
||||
This attribute is optional because it was added in a newer version
|
||||
than its parent node.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PreRemediationPowerAction</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction</span></code> class
|
||||
defines the possible actions to be taken, before entering maintenance mode.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">PreRemediationPowerAction</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE">
|
||||
<code class="sig-name descname"><span class="pre">DO_NOT_CHANGE_VMS_POWER_STATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not change the VM power state</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS">
|
||||
<code class="sig-name descname"><span class="pre">POWER_OFF_VMS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='POWER_OFF_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Power off VMs before entering maintenance mode.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS">
|
||||
<code class="sig-name descname"><span class="pre">SUSPEND_VMS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Suspend VMs before entering maintenance mode</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY">
|
||||
<code class="sig-name descname"><span class="pre">SUSPEND_VMS_TO_MEMORY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Suspend VMs to Memory before entering maintenance mode. This class
|
||||
attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FailureAction</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.FailureAction</span></code> class contains attributes that describe the
|
||||
actions to be taken when entering maintenance mode fails on a single host
|
||||
within the cluster.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action" title="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.FailureAction.Action</span></code></a>) – What action (FAIL, RETRY) is to be taken if entering maintenance
|
||||
mode fails on a single host within the cluster.</p></li>
|
||||
<li><p><strong>retry_delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time to wait to retry the failed operation in seconds.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Effective.FailureAction.Action.RETRY</span></code></a>.</p></li>
|
||||
<li><p><strong>retry_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of times to retry the failed operation.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Effective.FailureAction.Action.RETRY</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Action</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.FailureAction.Action</span></code> class defines the actions to be
|
||||
taken when entering maintenance mode fails on a single host within the
|
||||
cluster.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Action</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action.FAIL">
|
||||
<code class="sig-name descname"><span class="pre">FAIL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Action(string='FAIL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action.FAIL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail the apply method</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY">
|
||||
<code class="sig-name descname"><span class="pre">RETRY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Action(string='RETRY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retry the task Apply.FailureAction#retryCount number of times on the failed
|
||||
host after Apply.FailureAction#retryDelay.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the effective apply policy based on system defaults and what
|
||||
has been configured.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec" title="com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>The effective policies that impact the apply method</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is an unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters.policies.apply_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.defaults.clusters.policies.apply_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters.policies.apply_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -194,13 +194,13 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html">com.vmware.esx.settings.defaults.clusters.policies package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#com-vmware-esx-settings-defaults-clusters-policies-apply-client-module">com.vmware.esx.settings.defaults.clusters.policies.apply_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#module-com.vmware.esx.settings.defaults.clusters.policies.apply_client">com.vmware.esx.settings.defaults.clusters.policies.apply_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#com-vmware-esx-settings-defaults-clusters-policies-client-module">com.vmware.esx.settings.defaults.clusters.policies_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#module-com.vmware.esx.settings.defaults.clusters.policies_client">com.vmware.esx.settings.defaults.clusters.policies_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -209,8 +209,23 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-defaults-clusters-client-module">
|
||||
<h2>com.vmware.esx.settings.defaults.clusters_client module<a class="headerlink" href="#com-vmware-esx-settings-defaults-clusters-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.defaults.clusters_client">
|
||||
<span id="com-vmware-esx-settings-defaults-clusters-client-module"></span><h2>com.vmware.esx.settings.defaults.clusters_client module<a class="headerlink" href="#module-com.vmware.esx.settings.defaults.clusters_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.defaults.clusters_client</span></code> module provides
|
||||
classes to manage defaults that affect management of desired state
|
||||
configuration and software for ESXi clusters.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.defaults.clusters_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.defaults.clusters_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults.clusters_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,14 +189,610 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-depot-content-add-ons-client-module">
|
||||
<h2>com.vmware.esx.settings.depot_content.add_ons_client module<a class="headerlink" href="#com-vmware-esx-settings-depot-content-add-ons-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.depot_content.add_ons_client">
|
||||
<span id="com-vmware-esx-settings-depot-content-add-ons-client-module"></span><h2>com.vmware.esx.settings.depot_content.add_ons_client module<a class="headerlink" href="#module-com.vmware.esx.settings.depot_content.add_ons_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depot_content.add_ons_client</span></code> module provides
|
||||
classes to retrieve OEM specific add-on versions from the depot.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.depot_content.add_ons_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.depot_content.add_ons_client.</span></code><code class="sig-name descname"><span class="pre">Versions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions</span></code> class provides methods to get OEM add-on versions from the
|
||||
sync’ed and imported depots.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CategoryType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.CategoryType</span></code> class defines possible values of categories
|
||||
for a OEM add-on.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-depot-content-base-images-client-module">
|
||||
<h2>com.vmware.esx.settings.depot_content.base_images_client module<a class="headerlink" href="#com-vmware-esx-settings-depot-content-base-images-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryType</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType.BUGFIX">
|
||||
<code class="sig-name descname"><span class="pre">BUGFIX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='BUGFIX')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType.BUGFIX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bugfix</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType.ENHANCEMENT">
|
||||
<code class="sig-name descname"><span class="pre">ENHANCEMENT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='ENHANCEMENT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType.ENHANCEMENT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enhancement</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType.SECURITY">
|
||||
<code class="sig-name descname"><span class="pre">SECURITY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='SECURITY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType.SECURITY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Security</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.ComponentInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ComponentInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.ComponentInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.ComponentInfo</span></code> class defines the information regarding a
|
||||
component present in OEM add-on.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-depot-content-components-client-module">
|
||||
<h2>com.vmware.esx.settings.depot_content.components_client module<a class="headerlink" href="#com-vmware-esx-settings-depot-content-components-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the component.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the component.</p></li>
|
||||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the OEM add-on.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vendor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">components</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removed_components</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.Info</span></code> class defines the information regarding a OEM add-on
|
||||
version.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the OEM add-on.</p></li>
|
||||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the OEM add-on.</p></li>
|
||||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the OEM add-on.</p></li>
|
||||
<li><p><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Summary of the OEM add-on.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Discription of the OEM add-on.</p></li>
|
||||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType" title="com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.CategoryType</span></code></a>) – Category of the OEM add-on.</p></li>
|
||||
<li><p><strong>kb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Link to kb article related to this the OEM add-on.</p></li>
|
||||
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the OEM add-on.</p></li>
|
||||
<li><p><strong>components</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.ComponentInfo" title="com.vmware.esx.settings.depot_content.add_ons_client.Versions.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.ComponentInfo</span></code></a>) – List of components in this OEM add-on.</p></li>
|
||||
<li><p><strong>removed_components</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.RemovedComponentInfo" title="com.vmware.esx.settings.depot_content.add_ons_client.Versions.RemovedComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.RemovedComponentInfo</span></code></a>) – List of components removed by this OEM add-on.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.RemovedComponentInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">RemovedComponentInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.RemovedComponentInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.RemovedComponentInfo</span></code> class defines the information
|
||||
regarding a component removed by the OEM add-on.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the component.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about a given OEM add-on version in the depot.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the OEM add-on
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.add_on</span></code>.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the OEM add-on</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.Info" title="com.vmware.esx.settings.depot_content.add_ons_client.Versions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the given OEM add-on</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if OEM add-on with given version is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.esx.settings.depot_content.base_images_client">
|
||||
<span id="com-vmware-esx-settings-depot-content-base-images-client-module"></span><h2>com.vmware.esx.settings.depot_content.base_images_client module<a class="headerlink" href="#module-com.vmware.esx.settings.depot_content.base_images_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depot_content.base_images_client</span></code> module
|
||||
provides classes to retrieve base_images from the depot.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.depot_content.base_images_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.depot_content.base_images_client.</span></code><code class="sig-name descname"><span class="pre">Versions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions</span></code> class provides methods to get versions of base-images from
|
||||
the sync’ed and imported depots.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CategoryType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.CategoryType</span></code> class defines possible values of categories
|
||||
for a base-image.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryType</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType.BUGFIX">
|
||||
<code class="sig-name descname"><span class="pre">BUGFIX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='BUGFIX')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType.BUGFIX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bugfix</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType.ENHANCEMENT">
|
||||
<code class="sig-name descname"><span class="pre">ENHANCEMENT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='ENHANCEMENT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType.ENHANCEMENT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enhancement</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType.SECURITY">
|
||||
<code class="sig-name descname"><span class="pre">SECURITY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='SECURITY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType.SECURITY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Security</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.ComponentVersionInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ComponentVersionInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.ComponentVersionInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.ComponentVersionInfo</span></code> class defines the information
|
||||
regarding a component present inbase-image.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the component.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the component.</p></li>
|
||||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the base-image.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">components</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.Info</span></code> class defines the information regarding a base-image.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the base-image.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the base-image.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.base_image</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.base_image</span></code>.</p></li>
|
||||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the base-image.</p></li>
|
||||
<li><p><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Summary of the base-image.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Discription of the base-image.</p></li>
|
||||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType" title="com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.CategoryType</span></code></a>) – Category of the base-image.</p></li>
|
||||
<li><p><strong>kb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Link to kb article related to this the base-image.</p></li>
|
||||
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the base-image.</p></li>
|
||||
<li><p><strong>components</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.ComponentVersionInfo" title="com.vmware.esx.settings.depot_content.base_images_client.Versions.ComponentVersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.ComponentVersionInfo</span></code></a>) – List of components in this base-image.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about a given base-image version in the depot.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the base-image</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.Info" title="com.vmware.esx.settings.depot_content.base_images_client.Versions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the given base-image</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if base-image with given version is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.esx.settings.depot_content.components_client">
|
||||
<span id="com-vmware-esx-settings-depot-content-components-client-module"></span><h2>com.vmware.esx.settings.depot_content.components_client module<a class="headerlink" href="#module-com.vmware.esx.settings.depot_content.components_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depot_content.components_client</span></code> module provides
|
||||
classes to retrieve component versions from the depot.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.depot_content.components_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.depot_content.components_client.</span></code><code class="sig-name descname"><span class="pre">Versions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions</span></code> class provides methods to get component versions from the
|
||||
sync’ed and imported depots.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CategoryType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.CategoryType</span></code> class defines possible values of categories
|
||||
for a component.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryType</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.BUGFIX">
|
||||
<code class="sig-name descname"><span class="pre">BUGFIX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='BUGFIX')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.BUGFIX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bugfix</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.ENHANCEMENT">
|
||||
<code class="sig-name descname"><span class="pre">ENHANCEMENT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='ENHANCEMENT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.ENHANCEMENT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enhancement</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.GENERAL">
|
||||
<code class="sig-name descname"><span class="pre">GENERAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='GENERAL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.GENERAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>General</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.INFO">
|
||||
<code class="sig-name descname"><span class="pre">INFO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='INFO')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.INFO" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Info</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.MISC">
|
||||
<code class="sig-name descname"><span class="pre">MISC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='MISC')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.MISC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Misc</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.RECALL">
|
||||
<code class="sig-name descname"><span class="pre">RECALL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='RECALL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.RECALL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Recall</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.RECALL_FIX">
|
||||
<code class="sig-name descname"><span class="pre">RECALL_FIX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='RECALL_FIX')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.RECALL_FIX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Recall-fix</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.SECURITY">
|
||||
<code class="sig-name descname"><span class="pre">SECURITY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CategoryType(string='SECURITY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType.SECURITY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Security</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vendor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">urgency</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.Info</span></code> class defines the information regarding a component
|
||||
version.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the component.</p></li>
|
||||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the component.</p></li>
|
||||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the component.</p></li>
|
||||
<li><p><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Summary of the component version.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Discription of the component version.</p></li>
|
||||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType" title="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.CategoryType</span></code></a>) – Category of the component version.</p></li>
|
||||
<li><p><strong>urgency</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType" title="com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.UrgencyType</span></code></a>) – Urgency of the component version.</p></li>
|
||||
<li><p><strong>kb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Link to kb article related to this the component version.</p></li>
|
||||
<li><p><strong>contact</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Contact email for the component version.</p></li>
|
||||
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the component version.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UrgencyType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.UrgencyType</span></code> class defines possible values of urgencies for
|
||||
a component.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">UrgencyType</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.CRITICAL">
|
||||
<code class="sig-name descname"><span class="pre">CRITICAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UrgencyType(string='CRITICAL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.CRITICAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Critical</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.GENERAL">
|
||||
<code class="sig-name descname"><span class="pre">GENERAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UrgencyType(string='GENERAL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.GENERAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>General</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.IMPORTANT">
|
||||
<code class="sig-name descname"><span class="pre">IMPORTANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UrgencyType(string='IMPORTANT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.IMPORTANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Important</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.LOW">
|
||||
<code class="sig-name descname"><span class="pre">LOW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UrgencyType(string='LOW')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.LOW" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Low</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.MODERATE">
|
||||
<code class="sig-name descname"><span class="pre">MODERATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UrgencyType(string='MODERATE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType.MODERATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Moderate</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.depot_content.components_client.Versions.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about a given component version in the depot.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the component
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the component</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depot_content.components_client.Versions.Info" title="com.vmware.esx.settings.depot_content.components_client.Versions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the given component</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is unknown internal error. The accompanying error message
|
||||
will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if component with given version is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -192,7 +192,7 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html">com.vmware.esx.settings.hardware_support.managers package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#com-vmware-esx-settings-hardware-support-managers-packages-client-module">com.vmware.esx.settings.hardware_support.managers.packages_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#module-com.vmware.esx.settings.hardware_support.managers.packages_client">com.vmware.esx.settings.hardware_support.managers.packages_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -201,8 +201,156 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-hardware-support-managers-client-module">
|
||||
<h2>com.vmware.esx.settings.hardware_support.managers_client module<a class="headerlink" href="#com-vmware-esx-settings-hardware-support-managers-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.hardware_support.managers_client">
|
||||
<span id="com-vmware-esx-settings-hardware-support-managers-client-module"></span><h2>com.vmware.esx.settings.hardware_support.managers_client module<a class="headerlink" href="#module-com.vmware.esx.settings.hardware_support.managers_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers_client.Packages">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hardware_support.managers_client.</span></code><code class="sig-name descname"><span class="pre">Packages</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Packages</span></code> class provides methods to manage a host’s Hardware Support
|
||||
Package (HSP) configuration.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_image_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Packages.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing OEM Hardware Support Packages (HSPs), see
|
||||
<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.list" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Packages.list()</span></code></a>).</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>base_image_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – vSphere release version the Hardware Support Package (HSP) must
|
||||
support to match the filter. Only Hardware Support Packages (HSPs)
|
||||
compatible with the vSphere release version specified in
|
||||
‘baseImageVersion’ will be returned. The ‘baseImageVersion’
|
||||
parameter should be a full numeric base image version string (e.g.
|
||||
“7.1.0-2.3.436234”). Future implementations may support version
|
||||
specification by prefix (e.g. “7.1” to specify all updates and
|
||||
builds of 7.1) or other forms of specification (e.g. “>=7.0”).
|
||||
Hardware Support Pacakges (HSPs) may be advertised as supporting
|
||||
truncated version strings to indicate the remainder is wildcarded.
|
||||
Matching is on the specified substring only, so a bundle supporting
|
||||
“7.1.0-2” would match a ‘release’ parameter of “7.1.0-2.3.436234”
|
||||
as well as “7.1.0-2.1.4133564” and “7.1.0-1.0.355667” but not
|
||||
“7.1.0-3.0.63445” or any base image version starting with “7.2”.
|
||||
Note that we require compatible base image versions be specified at
|
||||
least down to the update version (i.e. “7.0” is insufficiently
|
||||
constrained)
|
||||
If None, all packages will be returned, regardless of base image
|
||||
version.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">HardwareSupportPackageInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_releases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Packages.HardwareSupportPackageInfo</span></code> class contains attributes that
|
||||
describe a particular 3rd party Hardware Support Package (HSP)</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>pkg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Hardware Support Package (e.g. “Jan. 2018 Release” or
|
||||
“Latest Hardware Support Package for Frobozz GenX hardware”)
|
||||
selected
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the Hardware Support Package (e.g. “20180128.1” or
|
||||
“v42”) selected</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Hardware Support Package (HSP) (e.g. for use in
|
||||
help bubble)</p></li>
|
||||
<li><p><strong>supported_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Supported vSphere releases</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers_client.Packages.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the list of available Hardware Support Packages (HSPs) for a
|
||||
particular host, as specified by its Hardware Support Manager (HSM)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>manager</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Hardware Support Manager (HSM).
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.manager</span></code>.</p></li>
|
||||
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Packages.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of Hardware Support Packages (HSPs) to be returned
|
||||
If None, the behavior is equivalent to a
|
||||
<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Packages.FilterSpec</span></code></a> with all attributes None, which means
|
||||
all HSPs match the filter.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.list" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Packages.HardwareSupportPackageInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>List of available Hardware Support Packages (HSPs) for given
|
||||
manager</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no Hardware Support Manager (HSM) with the specified
|
||||
name</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated. named <code class="docutils literal notranslate"><span class="pre">manager</span></code> in the
|
||||
system.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hardware_support.managers_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -191,8 +191,230 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-esx-settings-hardware-support-managers-packages-client-module">
|
||||
<h2>com.vmware.esx.settings.hardware_support.managers.packages_client module<a class="headerlink" href="#com-vmware-esx-settings-hardware-support-managers-packages-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.esx.settings.hardware_support.managers.packages_client">
|
||||
<span id="com-vmware-esx-settings-hardware-support-managers-packages-client-module"></span><h2>com.vmware.esx.settings.hardware_support.managers.packages_client module<a class="headerlink" href="#module-com.vmware.esx.settings.hardware_support.managers.packages_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hardware_support.managers.packages_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hardware_support.managers.packages_client.</span></code><code class="sig-name descname"><span class="pre">Versions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions</span></code> class provides methods to inspect a Hardware Support
|
||||
Package (HSP)’s detailed information.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.ComponentInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ComponentInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.ComponentInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.ComponentInfo</span></code> class defines the information regarding a
|
||||
component present in HSP manifest.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the component.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the component.</p></li>
|
||||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the HSP manifest.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_image_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when retrieving Hardware Support Packages (HSPs) information.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>base_image_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – vSphere release version for the component information in the
|
||||
Hardware Support Package (HSP). Only Hardware Support Packages
|
||||
(HSPs) compatible with the vSphere release version specified in
|
||||
‘baseImageVersion’ will be returned. The ‘baseImageVersion’
|
||||
parameter should be a full numeric base image version string (e.g.
|
||||
“7.1.0-2.3.436234”). Future implementations may support version
|
||||
specification by prefix (e.g. “7.1” to specify all updates and
|
||||
builds of 7.1) or other forms of specification (e.g. “>=7.0”).
|
||||
Hardware Support Pacakges (HSPs) may be advertised as supporting
|
||||
truncated version strings to indicate the remainder is wildcarded.
|
||||
Matching is on the specified substring only, so a bundle supporting
|
||||
“7.1.0-2” would match a ‘release’ parameter of “7.1.0-2.3.436234”
|
||||
as well as “7.1.0-2.1.4133564” and “7.1.0-2.0.355667” but not
|
||||
“7.1.0-3.0.63445” or any base image version starting with “7.2”.
|
||||
Note that we require compatible base image versions be specified at
|
||||
least down to the update version (i.e. “7.0” is insufficiently
|
||||
constrained)
|
||||
If None, all supported releases will be returned but no specific
|
||||
component information (added or deleted) will be included.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.PackageInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PackageInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_releases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">components</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removed_components</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.PackageInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.PackageInfo</span></code> class contains attributes that describe a
|
||||
particular 3rd party Hardware Support Package (HSP)</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>pkg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Hardware Support Package (e.g. “Jan. 2018 Release” or
|
||||
“Latest Hardware Support Package for Frobozz GenX hardware”)
|
||||
selected
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the Hardware Support Package (e.g. “20180128.1” or
|
||||
“v42”) selected</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Hardware Support Package (HSP) (e.g. for use in
|
||||
help bubble)</p></li>
|
||||
<li><p><strong>supported_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Supported vSphere releases</p></li>
|
||||
<li><p><strong>components</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.ComponentInfo" title="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.ComponentInfo</span></code></a>) – List of components in this HSP manifest.</p></li>
|
||||
<li><p><strong>removed_components</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.RemovedComponentInfo" title="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.RemovedComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.RemovedComponentInfo</span></code></a>) – List of components removed by this HSP manifest.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.RemovedComponentInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">RemovedComponentInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.RemovedComponentInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.RemovedComponentInfo</span></code> class defines the information
|
||||
regarding a component removed by the HSP manifest.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the component.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the detailed information for a specific version of an available
|
||||
Hardware Support Packages (HSPs) as specified by the Hardware Support
|
||||
Manager (HSM)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>manager</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Hardware Support Manager (HSM).
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.manager</span></code>.</p></li>
|
||||
<li><p><strong>pkg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the Hardware Support Package (HSP)
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the Hardware Support Package (HSP)</p></li>
|
||||
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec" title="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of detailed information to be returned
|
||||
If None, the behavior is equivalent to a
|
||||
<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec" title="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.FilterSpec</span></code></a> with all attributes None, which means
|
||||
all releases supported are returned but no component information
|
||||
for any particular release is included.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.PackageInfo" title="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.PackageInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>detailed information on Hardware Support Packages (HSPs)</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If there is some unknown internal error. The accompanying error
|
||||
message will give more details about the failure.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
If any of the specified parameters are Invalid (e.g. if the release
|
||||
version specified in the query parameter is not, in fact, among
|
||||
those supported by the Hardware Support Package (HSP).</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If there is no Hardware Support Manager (HSM) with the specified
|
||||
name, or no Hardware Support Package (HSP) with the specified name
|
||||
and version.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
If the service is not available.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated. named <code class="docutils literal notranslate"><span class="pre">manager</span></code> in the
|
||||
system.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have the required privilege to perform the
|
||||
operation.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -185,8 +185,187 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-oauth2-errors-client-module">
|
||||
<h2>com.vmware.oauth2.errors_client module<a class="headerlink" href="#com-vmware-oauth2-errors-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.oauth2.errors_client">
|
||||
<span id="com-vmware-oauth2-errors-client-module"></span><h2>com.vmware.oauth2.errors_client module<a class="headerlink" href="#module-com.vmware.oauth2.errors_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.oauth2.errors_client</span></code> module provides the OAuth 2.0
|
||||
exceptions that can be included in the list of exceptions in the specification
|
||||
of OAuth 2.0 methods to indicate that the method might report those exceptions.</p>
|
||||
<dl class="py exception">
|
||||
<dt id="com.vmware.oauth2.errors_client.Error">
|
||||
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></code><code class="sig-name descname"><span class="pre">Error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.error.VapiError</span></code></p>
|
||||
<p>The OAuth2 <code class="docutils literal notranslate"><span class="pre">Error</span></code> describes the attributes common to standard OAuth 2.0
|
||||
exceptions.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
||||
type.</p></li>
|
||||
<li><p><strong>error_description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Human-readable ASCII text providing additional information, used to
|
||||
assist the client developer in understanding the error that
|
||||
occurred. Values for the “error_description” parameter MUST NOT
|
||||
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
|
||||
if no additional information is available.</p></li>
|
||||
<li><p><strong>error_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A URI identifying a human-readable web page with information about
|
||||
the error, used to provide the client developer with additional
|
||||
information about the error.
|
||||
if no such web-page is available.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.oauth2.errors_client.Error.Type">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>Enumeration of OAuth 2.0 exceptions.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.oauth2.errors_client.Error.Type.invalid_grant">
|
||||
<code class="sig-name descname"><span class="pre">invalid_grant</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='invalid_grant')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.invalid_grant" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.InvalidGrant" title="com.vmware.oauth2.errors_client.InvalidGrant"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidGrant</span></code></a> type.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.oauth2.errors_client.Error.Type.invalid_request">
|
||||
<code class="sig-name descname"><span class="pre">invalid_request</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='invalid_request')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.invalid_request" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.InvalidRequest" title="com.vmware.oauth2.errors_client.InvalidRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidRequest</span></code></a> type.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.oauth2.errors_client.Error.Type.invalid_scope">
|
||||
<code class="sig-name descname"><span class="pre">invalid_scope</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='invalid_scope')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.invalid_scope" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.InvalidScope" title="com.vmware.oauth2.errors_client.InvalidScope"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidScope</span></code></a> type.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="com.vmware.oauth2.errors_client.InvalidGrant">
|
||||
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></code><code class="sig-name descname"><span class="pre">InvalidGrant</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INVALID_GRANT'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.oauth2.errors_client.InvalidGrant" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.oauth2.errors_client.Error</span></code></a></p>
|
||||
<p>Indicates that the provided authorization grant (e.g., authorization code,
|
||||
resource owner credentials) or refresh token is invalid, expired, revoked,
|
||||
does not match the redirection URI used in the authorization request, or
|
||||
was issued to another client.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
||||
type.</p></li>
|
||||
<li><p><strong>error_description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Human-readable ASCII text providing additional information, used to
|
||||
assist the client developer in understanding the error that
|
||||
occurred. Values for the “error_description” parameter MUST NOT
|
||||
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
|
||||
if no additional information is available.</p></li>
|
||||
<li><p><strong>error_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A URI identifying a human-readable web page with information about
|
||||
the error, used to provide the client developer with additional
|
||||
information about the error.
|
||||
if no such web-page is available.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="com.vmware.oauth2.errors_client.InvalidRequest">
|
||||
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></code><code class="sig-name descname"><span class="pre">InvalidRequest</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INVALID_REQUEST'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.oauth2.errors_client.InvalidRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.oauth2.errors_client.Error</span></code></a></p>
|
||||
<p>Indicates that the request is missing a required parameter, includes an
|
||||
unsupported parameter value (other than grant type), repeats a parameter,
|
||||
includes multiple credentials, utilizes more than one mechanism for
|
||||
authenticating the client, or is otherwise malformed</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
||||
type.</p></li>
|
||||
<li><p><strong>error_description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Human-readable ASCII text providing additional information, used to
|
||||
assist the client developer in understanding the error that
|
||||
occurred. Values for the “error_description” parameter MUST NOT
|
||||
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
|
||||
if no additional information is available.</p></li>
|
||||
<li><p><strong>error_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A URI identifying a human-readable web page with information about
|
||||
the error, used to provide the client developer with additional
|
||||
information about the error.
|
||||
if no such web-page is available.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="com.vmware.oauth2.errors_client.InvalidScope">
|
||||
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></code><code class="sig-name descname"><span class="pre">InvalidScope</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INVALID_SCOPE'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.oauth2.errors_client.InvalidScope" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.oauth2.errors_client.Error</span></code></a></p>
|
||||
<p>Indicates that the requested scope is invalid, unknown, malformed, or
|
||||
exceeds the scope granted by the resource owner.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
||||
type.</p></li>
|
||||
<li><p><strong>error_description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Human-readable ASCII text providing additional information, used to
|
||||
assist the client developer in understanding the error that
|
||||
occurred. Values for the “error_description” parameter MUST NOT
|
||||
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
|
||||
if no additional information is available.</p></li>
|
||||
<li><p><strong>error_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A URI identifying a human-readable web page with information about
|
||||
the error, used to provide the client developer with additional
|
||||
information about the error.
|
||||
if no such web-page is available.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.oauth2.errors_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.oauth2.errors_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -190,33 +190,33 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html">com.vmware.vapi.metadata.authentication package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#com-vmware-vapi-metadata-authentication-service-client-module">com.vmware.vapi.metadata.authentication.service_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication.service_client">com.vmware.vapi.metadata.authentication.service_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html">com.vmware.vapi.metadata.metamodel package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#com-vmware-vapi-metadata-metamodel-resource-client-module">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#com-vmware-vapi-metadata-metamodel-service-client-module">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.resource_client">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.service_client">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html">com.vmware.vapi.metadata.privilege package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#com-vmware-vapi-metadata-privilege-service-client-module">com.vmware.vapi.metadata.privilege.service_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege.service_client">com.vmware.vapi.metadata.privilege.service_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#com-vmware-vapi-metadata-authentication-client-module">com.vmware.vapi.metadata.authentication_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#com-vmware-vapi-metadata-cli-client-module">com.vmware.vapi.metadata.cli_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#com-vmware-vapi-metadata-metamodel-client-module">com.vmware.vapi.metadata.metamodel_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#com-vmware-vapi-metadata-privilege-client-module">com.vmware.vapi.metadata.privilege_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.authentication_client">com.vmware.vapi.metadata.authentication_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.cli_client">com.vmware.vapi.metadata.cli_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client">com.vmware.vapi.metadata.metamodel_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#com-vmware-vapi-std-errors-client-module">com.vmware.vapi.std.errors_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#com-vmware-vapi-std-interposition-client-module">com.vmware.vapi.std.interposition_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client">com.vmware.vapi.std.errors_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.interposition_client">com.vmware.vapi.std.interposition_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -225,11 +225,564 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vapi-metadata-client-module">
|
||||
<h2>com.vmware.vapi.metadata_client module<a class="headerlink" href="#com-vmware-vapi-metadata-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vapi.metadata_client">
|
||||
<span id="com-vmware-vapi-metadata-client-module"></span><h2>com.vmware.vapi.metadata_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <a class="reference internal" href="#module-com.vmware.vapi.metadata_client" title="com.vmware.vapi.metadata_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata_client</span></code></a> module provides metadata classes.
|
||||
These are classes that provide different facets of API information. Clients can
|
||||
use these classes to:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Discover APIs available in the infrastructure.</p></li>
|
||||
<li><p>Fetch metadata that can be used to build presentation layers like CLI, REST,
|
||||
etc.</p></li>
|
||||
<li><p>Fetch authentication and authorization metadata.</p></li>
|
||||
</ul>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceCreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata_client.</span></code><code class="sig-name descname"><span class="pre">SourceCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceCreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">SourceCreateSpec</span></code> class contains the registration information for a
|
||||
metadata source.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vapi-std-client-module">
|
||||
<h2>com.vmware.vapi.std_client module<a class="headerlink" href="#com-vmware-vapi-std-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language human readable description of the source.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a>) – Type of the metadata source.</p></li>
|
||||
<li><p><strong>filepath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute file path of the metamodel metadata file that has the
|
||||
metamodel information about one component element.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="com.vmware.vapi.metadata_client.SourceType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.FILE</span></code></a>.</p></li>
|
||||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Connection information of the remote server. This should be of the
|
||||
format http(s)://IP:port/namespace.</p>
|
||||
<p>The remote server should contain the classes in
|
||||
<a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client" title="com.vmware.vapi.metadata.metamodel_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client</span></code></a> module. It could
|
||||
expose metamodel information of one or more components.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata_client.</span></code><code class="sig-name descname"><span class="pre">SourceInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remote_addr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg_protocol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Metadata source info</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a>) – Type of the metadata source</p></li>
|
||||
<li><p><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the metadata source file
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="com.vmware.vapi.metadata_client.SourceType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.FILE</span></code></a>.</p></li>
|
||||
<li><p><strong>remote_addr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Address of the remote metadata source
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p></li>
|
||||
<li><p><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message protocol to be used
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata_client.</span></code><code class="sig-name descname"><span class="pre">SourceType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">SourceType</span></code> class defines the types of sources for API metadata. You
|
||||
specify the type of source when adding a metadata source to a metadata
|
||||
service.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceType.FILE">
|
||||
<code class="sig-name descname"><span class="pre">FILE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SourceType(string='FILE')</span></em><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates the metadata source is a JSON file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceType.REMOTE">
|
||||
<code class="sig-name descname"><span class="pre">REMOTE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SourceType(string='REMOTE')</span></em><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates the metadata source is a remote server.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vapi.std_client">
|
||||
<span id="com-vmware-vapi-std-client-module"></span><h2>com.vmware.vapi.std_client module<a class="headerlink" href="#module-com.vmware.vapi.std_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client</span></code> module provides standard types that can be
|
||||
used in the interface specification of any class.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></code><code class="sig-name descname"><span class="pre">AuthenticationScheme</span></code><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <a class="reference internal" href="#com.vmware.vapi.std_client.AuthenticationScheme" title="com.vmware.vapi.std_client.AuthenticationScheme"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuthenticationScheme</span></code></a> class defines constants for
|
||||
authentication scheme identifiers for authentication mechanisms present in
|
||||
the vAPI infrastructure shipped by VMware.</p>
|
||||
<p>A third party extension can define and implements it’s own authentication
|
||||
mechanism and define a constant in a different IDL file.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION">
|
||||
<code class="sig-name descname"><span class="pre">NO_AUTHENTICATION</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.no_authentication'</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the request doesn’t need any authentication.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN">
|
||||
<code class="sig-name descname"><span class="pre">OAUTH_ACCESS_TOKEN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.oauth'</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using OAuth2 based
|
||||
authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li><p>The scheme identifier - com.vmware.vapi.std.security.oauth</p></li>
|
||||
<li><p>Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization
|
||||
Server after successful authentication of the end user.</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id1"><span class="problematic" id="id2">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.oauth’,
|
||||
‘accesstoken’: ….
|
||||
}``
|
||||
vAPI runtime provides convenient factory methods that takes OAuth2 access token
|
||||
as input parameter and creates a security context that conforms to the above
|
||||
format.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN">
|
||||
<code class="sig-name descname"><span class="pre">SAML_BEARER_TOKEN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.saml_bearer_token'</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using a SAML bearer token
|
||||
based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li><p>The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token</p></li>
|
||||
<li><p>The token itself</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id3"><span class="problematic" id="id4">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.saml_bearer_token’,
|
||||
‘token’: ‘the token itself’
|
||||
}`` vAPI runtime provide convenient factory methods that take SAML bearer token
|
||||
and to create the security context that conforms to the above mentioned format.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN">
|
||||
<code class="sig-name descname"><span class="pre">SAML_HOK_TOKEN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.saml_hok_token'</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using a SAML holder-of-key
|
||||
token based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li><p>The scheme identifier: com.vmware.vapi.std.security.saml_hok_token</p></li>
|
||||
<li><p>Signature of the request: This includes - algorithm used for signing the
|
||||
request, SAML holder of key token and signature digest</p></li>
|
||||
<li><p>Request timestamp: This includes the <code class="docutils literal notranslate"><span class="pre">created</span></code> and <code class="docutils literal notranslate"><span class="pre">expires</span></code> timestamp of
|
||||
the request. The timestamp should match the following format -
|
||||
YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id5"><span class="problematic" id="id6">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.saml_hok_token’,
|
||||
‘signature’: {
|
||||
‘alg’: ‘RS256’,
|
||||
‘samlToken’: …,
|
||||
‘value’: …,``, ‘timestamp’: { ‘created’: ‘2012-10-26T12:24:18.941Z’,
|
||||
‘expires’: ‘2012-10-26T12:44:18.941Z’, } } } vAPI runtime provide convenient
|
||||
factory methods that take SAML holder of key token and private key to create
|
||||
the security context that conforms to the above mentioned format.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID">
|
||||
<code class="sig-name descname"><span class="pre">SESSION_ID</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.session_id'</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using a session identifier
|
||||
based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li><p>The scheme identifier - com.vmware.vapi.std.security.session_id</p></li>
|
||||
<li><p>Valid session identifier - This is usually returned by a login method of a
|
||||
session manager interface for a particular vAPI service of this authentication
|
||||
scheme</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id7"><span class="problematic" id="id8">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.session_id’,
|
||||
‘sessionId’: ….,
|
||||
}`` vAPI runtime provides convenient factory methods that take session
|
||||
identifier as input parameter and create a security context that conforms to
|
||||
the above format.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD">
|
||||
<code class="sig-name descname"><span class="pre">USER_PASSWORD</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.user_pass'</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using username/password
|
||||
based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li><p>The scheme identifier - com.vmware.vapi.std.security.user_pass</p></li>
|
||||
<li><p>Username</p></li>
|
||||
<li><p>Password</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id9"><span class="problematic" id="id10">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.user_pass’,
|
||||
‘userName’: ….,
|
||||
‘password’: …
|
||||
}``
|
||||
vAPI runtime provides convenient factory methods that take username and
|
||||
password as input parameters and create a security context that conforms to the
|
||||
above format.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.std_client.DynamicID">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></code><code class="sig-name descname"><span class="pre">DynamicID</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.DynamicID" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">DynamicID</span></code> class represents an identifier for a resource of an
|
||||
arbitrary type.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The type of resource being identified (for example
|
||||
<code class="docutils literal notranslate"><span class="pre">com.acme.Person</span></code>).</p>
|
||||
<p>Classes that contain methods for creating and deleting resources
|
||||
typically contain a class attribute specifying the resource type
|
||||
for the resources being created and deleted. The API metamodel
|
||||
metadata classes include a class that allows retrieving all the
|
||||
known resource types.</p>
|
||||
</p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier for a resource whose type is specified by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">DynamicID.type</span></code>.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> must contain the actual resource type. When
|
||||
methods return a value of this class as a return value, the
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> will contain the actual resource type.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizableMessage">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></code><code class="sig-name descname"><span class="pre">LocalizableMessage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">localized</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">LocalizableMessage</span></code> class represents localizable string and message
|
||||
template. Classes include one or more localizable message templates in the
|
||||
exceptions they report so that clients can display diagnostic messages in
|
||||
the native language of the user. Classes can include localizable strings in
|
||||
the data returned from methods to allow clients to display localized status
|
||||
information in the native language of the user.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Unique identifier of the localizable string or message template.</p>
|
||||
<p>This identifier is typically used to retrieve a locale-specific
|
||||
string or message template from a message catalog.</p>
|
||||
</p></li>
|
||||
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of this localizable string or message template in the
|
||||
<code class="docutils literal notranslate"><span class="pre">en_US</span></code> (English) locale. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">LocalizableMessage.id</span></code> refers
|
||||
to a message template, the default message will contain the
|
||||
substituted arguments. This value can be used by clients that do
|
||||
not need to display strings and messages in the native language of
|
||||
the user. It could also be used as a fallback if a client is unable
|
||||
to access the appropriate message catalog.</p></li>
|
||||
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Positional arguments to be substituted into the message template.
|
||||
This list will be empty if the message uses named arguments or has
|
||||
no arguments.</p></li>
|
||||
<li><p><strong>params</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.std_client.LocalizationParam" title="com.vmware.vapi.std_client.LocalizationParam"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalizationParam</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Named arguments to be substituted into the message template. This
|
||||
attribute was added in vSphere API 7.0.0.0.
|
||||
None means that the message template requires no arguments or
|
||||
positional arguments are used.</p></li>
|
||||
<li><p><strong>localized</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Localized string value as per request requirements. This attribute
|
||||
was added in vSphere API 7.0.0.0.
|
||||
when the client has not requested specific locale the
|
||||
implementation may not populate this field to conserve resources.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></code><code class="sig-name descname"><span class="pre">LocalizationParam</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">d</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">l</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">precision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>This class holds a single message parameter and formatting settings for it.
|
||||
The class has fields for <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>,
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code>, date time and nested messages. Only one will be
|
||||
used depending on the type of data sent. For date, <code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code>
|
||||
and <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code> it is possible to set additional formatting details. This
|
||||
class was added in vSphere API 7.0.0.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>s</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> value associated with the parameter. This attribute
|
||||
was added in vSphere API 7.0.0.0.
|
||||
this attribute will be set when <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> value is used.</p></li>
|
||||
<li><p><strong>dt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date and time value associated with the parameter. Use the
|
||||
<code class="docutils literal notranslate"><span class="pre">format</span></code> attribute to specify date and time display style. This
|
||||
attribute was added in vSphere API 7.0.0.0.
|
||||
this attribute will be set when date and time value is used.</p></li>
|
||||
<li><p><strong>i</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code> value associated with the parameter. This attribute
|
||||
was added in vSphere API 7.0.0.0.
|
||||
this attribute will be set when <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code> value is used.</p></li>
|
||||
<li><p><strong>d</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code> value associated with the parameter.
|
||||
The number of displayed fractional digits is changed via
|
||||
<code class="docutils literal notranslate"><span class="pre">precision</span></code> attribute. This attribute was added in vSphere API
|
||||
7.0.0.0.
|
||||
this attribute will be set when <code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code> value is
|
||||
used.</p></li>
|
||||
<li><p><strong>l</strong> (<a class="reference internal" href="#com.vmware.vapi.std_client.NestedLocalizableMessage" title="com.vmware.vapi.std_client.NestedLocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">NestedLocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Nested localizable value associated with the parameter. This is
|
||||
useful construct to convert to human readable localized form class
|
||||
and <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> values. It can also be used for proper handling
|
||||
of pluralization and gender forms in localization. Recursive
|
||||
<code class="docutils literal notranslate"><span class="pre">NestedLocalizableMessage</span></code> instances can be used for localizing
|
||||
short lists of items. This attribute was added in vSphere API
|
||||
7.0.0.0.
|
||||
this attribute will be set when nested localization message value
|
||||
is used.</p></li>
|
||||
<li><p><strong>format</strong> (<a class="reference internal" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat" title="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalizationParam.DateTimeFormat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Format associated with the date and time value in <code class="docutils literal notranslate"><span class="pre">dt</span></code> attribute.
|
||||
The class attribute <code class="docutils literal notranslate"><span class="pre">SHORT_DATETIME</span></code> will be used as default.
|
||||
This attribute was added in vSphere API 7.0.0.0.
|
||||
this may not be set if class attribute <code class="docutils literal notranslate"><span class="pre">SHORT_DATETIME</span></code> default
|
||||
format is appropriate</p></li>
|
||||
<li><p><strong>precision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of fractional digits to include in formatted
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code> value. This attribute was added in vSphere
|
||||
API 7.0.0.0.
|
||||
this will be set when exact precision is required for rendering
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code> numbers.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DateTimeFormat</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">LocalizationParam.DateTimeFormat</span></code> class lists possible date and time
|
||||
formatting options. It combines the Unicode CLDR format types - full, long,
|
||||
medium and short with 3 different presentations - date only, time only and
|
||||
combined date and time presentation. This enumeration was added in vSphere
|
||||
API 7.0.0.0.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">DateTimeFormat</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_DATE">
|
||||
<code class="sig-name descname"><span class="pre">FULL_DATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='FULL_DATE')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as full date, for example <em>2019
|
||||
Jan 28, Mon</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_DATE_TIME">
|
||||
<code class="sig-name descname"><span class="pre">FULL_DATE_TIME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='FULL_DATE_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_DATE_TIME" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as full date and time, for
|
||||
example <em>2019 Jan 28, Mon 12:59:01 Z</em>. This class attribute was added in
|
||||
vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_TIME">
|
||||
<code class="sig-name descname"><span class="pre">FULL_TIME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='FULL_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_TIME" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as full time, for example
|
||||
<em>12:59:01 Z</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_DATE">
|
||||
<code class="sig-name descname"><span class="pre">LONG_DATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='LONG_DATE')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as long date, for example <em>2019
|
||||
Jan 28</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_DATE_TIME">
|
||||
<code class="sig-name descname"><span class="pre">LONG_DATE_TIME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='LONG_DATE_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_DATE_TIME" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as long date and time, for
|
||||
example <em>2019 Jan 28 12:59:01 Z</em>. This class attribute was added in vSphere
|
||||
API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_TIME">
|
||||
<code class="sig-name descname"><span class="pre">LONG_TIME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='LONG_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_TIME" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as long time, for example
|
||||
<em>12:59:01 Z</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_DATE">
|
||||
<code class="sig-name descname"><span class="pre">MED_DATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='MED_DATE')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as medium date, for example <em>2019
|
||||
Jan 28</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_DATE_TIME">
|
||||
<code class="sig-name descname"><span class="pre">MED_DATE_TIME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='MED_DATE_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_DATE_TIME" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as medium date and time, for
|
||||
example <em>2019 Jan 28 12:59:01</em>. This class attribute was added in vSphere
|
||||
API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_TIME">
|
||||
<code class="sig-name descname"><span class="pre">MED_TIME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='MED_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_TIME" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as medium time, for example
|
||||
<em>12:59:01</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_DATE">
|
||||
<code class="sig-name descname"><span class="pre">SHORT_DATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='SHORT_DATE')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as short date, for example
|
||||
<em>2019-01-28</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_DATE_TIME">
|
||||
<code class="sig-name descname"><span class="pre">SHORT_DATE_TIME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='SHORT_DATE_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_DATE_TIME" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as short date and time, for
|
||||
example <em>2019-01-28 12:59</em>. This class attribute was added in vSphere API
|
||||
7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_TIME">
|
||||
<code class="sig-name descname"><span class="pre">SHORT_TIME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='SHORT_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_TIME" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The date and time value will be formatted as short time, for example
|
||||
<em>12:59</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.std_client.NestedLocalizableMessage">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></code><code class="sig-name descname"><span class="pre">NestedLocalizableMessage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.NestedLocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">NestedLocalizableMessage</span></code> class represents a nested within a
|
||||
parameter localizable string or message template. This class is useful for
|
||||
modeling composite messages. Such messages are necessary to do correct
|
||||
pluralization of phrases, represent lists of several items etc. This class
|
||||
was added in vSphere API 7.0.0.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Unique identifier of the localizable string or message template.</p>
|
||||
<p>This identifier is typically used to retrieve a locale-specific
|
||||
string or message template from a message catalog.. This attribute
|
||||
was added in vSphere API 7.0.0.0.</p>
|
||||
</p></li>
|
||||
<li><p><strong>params</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.std_client.LocalizationParam" title="com.vmware.vapi.std_client.LocalizationParam"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalizationParam</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Named Arguments to be substituted into the message template. This
|
||||
attribute was added in vSphere API 7.0.0.0.
|
||||
services will not populate this field when there are no parameters
|
||||
to be substituted</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.std_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,8 +189,115 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vapi-metadata-authentication-service-client-module">
|
||||
<h2>com.vmware.vapi.metadata.authentication.service_client module<a class="headerlink" href="#com-vmware-vapi-metadata-authentication-service-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vapi.metadata.authentication.service_client">
|
||||
<span id="com-vmware-vapi-metadata-authentication-service-client-module"></span><h2>com.vmware.vapi.metadata.authentication.service_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.authentication.service_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.authentication.service_client</span></code> module provides
|
||||
classes to retrieve authentication information for operation elements.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.Operation">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata.authentication.service_client.</span></code><code class="sig-name descname"><span class="pre">Operation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Operation</span></code> class provides methods to retrieve authentication
|
||||
information of an operation element.</p>
|
||||
<p>An operation element is said to contain authentication information if
|
||||
authentication schemes are specified in the authentication definition file.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.Operation.RESOURCE_TYPE">
|
||||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.operation'</span></em><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for operation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.Operation.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves the authentication information about an operation element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> contained in the service element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.authentication_client.OperationInfo" title="com.vmware.vapi.metadata.authentication_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.authentication_client.OperationInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The
|
||||
<a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.authentication_client.OperationInfo" title="com.vmware.vapi.metadata.authentication_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.authentication_client.OperationInfo</span></code></a>
|
||||
instance that corresponds to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not
|
||||
exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
exist.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
have any authentication information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.Operation.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the identifiers for the operation elements contained in the
|
||||
service element corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code> that have
|
||||
authentication information.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.list" title="com.vmware.vapi.metadata.authentication.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>List of identifiers for the operation elements contained in the
|
||||
service element that have authentication information.
|
||||
The return value will contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not have
|
||||
any operation elements that have authentication information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata.authentication.service_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,11 +189,176 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vapi-metadata-metamodel-resource-client-module">
|
||||
<h2>com.vmware.vapi.metadata.metamodel.resource_client module<a class="headerlink" href="#com-vmware-vapi-metadata-metamodel-resource-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vapi.metadata.metamodel.resource_client">
|
||||
<span id="com-vmware-vapi-metadata-metamodel-resource-client-module"></span><h2>com.vmware.vapi.metadata.metamodel.resource_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.metamodel.resource_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel.resource_client</span></code> module provides
|
||||
classes to retrieve metamodel information for resource types.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.resource_client.Model">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata.metamodel.resource_client.</span></code><code class="sig-name descname"><span class="pre">Model</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.resource_client.Model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Model</span></code> class provides methods to retrieve information about models.</p>
|
||||
<p>A structure is used as a model if it is used for persisting data about an
|
||||
entity. Some of the fields in the model structure are also used for
|
||||
creating indexes for querying.</p>
|
||||
<p>One or more services can operate on the same resource type. One or more
|
||||
services can provide the model structure for an entity of this resource
|
||||
type. Using <code class="docutils literal notranslate"><span class="pre">Model</span></code> class you can retrieve the list of all the structure
|
||||
elements that are model structures for a given resource type.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.resource_client.Model.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.resource_client.Model.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the set of identifiers for the structure elements that are
|
||||
models for the resource type corresponding to <code class="docutils literal notranslate"><span class="pre">resource_id</span></code>.</p>
|
||||
<p>The <a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.metamodel_client.Structure" title="com.vmware.vapi.metadata.metamodel_client.Structure"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client.Structure</span></code></a> class
|
||||
provides methods to retrieve more details about the structure elements
|
||||
corresponding to the identifiers returned by this method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>resource_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the resource type.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The set of identifiers for the models that are associated with the
|
||||
resource type in <code class="docutils literal notranslate"><span class="pre">resource_id</span></code>.
|
||||
The return value will contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the resource type associated with <code class="docutils literal notranslate"><span class="pre">resource_id</span></code> does not
|
||||
exist.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.resource_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata.metamodel.resource_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.resource_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vapi-metadata-metamodel-service-client-module">
|
||||
<h2>com.vmware.vapi.metadata.metamodel.service_client module<a class="headerlink" href="#com-vmware-vapi-metadata-metamodel-service-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vapi.metadata.metamodel.service_client">
|
||||
<span id="com-vmware-vapi-metadata-metamodel-service-client-module"></span><h2>com.vmware.vapi.metadata.metamodel.service_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.metamodel.service_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel.service_client</span></code> module provides
|
||||
classes to retrieve metamodel information about the elements contained in a
|
||||
service element.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.Operation">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata.metamodel.service_client.</span></code><code class="sig-name descname"><span class="pre">Operation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Operation</span></code> class provides methods to retrieve metamodel information
|
||||
of an operation element in the interface definition language.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.Operation.RESOURCE_TYPE">
|
||||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.operation'</span></em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for operation element.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.Operation.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves the metamodel information about an operation element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> contained in the service element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.metamodel_client.OperationInfo" title="com.vmware.vapi.metadata.metamodel_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client.OperationInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The
|
||||
<a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.metamodel_client.OperationInfo" title="com.vmware.vapi.metadata.metamodel_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client.OperationInfo</span></code></a>
|
||||
instance that corresponds to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> defined in scope
|
||||
<code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not
|
||||
exist in any of the package elements.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
exist in the service element.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.Operation.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the identifiers for the operation elements that are defined in
|
||||
the scope of <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.list" title="com.vmware.vapi.metadata.metamodel.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The list of identifiers for the operation elements that are defined
|
||||
in the scope of <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.
|
||||
The return value will contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not
|
||||
exist in any of the package elements.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata.metamodel.service_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,8 +189,117 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vapi-metadata-privilege-service-client-module">
|
||||
<h2>com.vmware.vapi.metadata.privilege.service_client module<a class="headerlink" href="#com-vmware-vapi-metadata-privilege-service-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vapi.metadata.privilege.service_client">
|
||||
<span id="com-vmware-vapi-metadata-privilege-service-client-module"></span><h2>com.vmware.vapi.metadata.privilege.service_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.privilege.service_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege.service_client</span></code> module provides
|
||||
classes to retrieve privilege information for operation elements.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.Operation">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata.privilege.service_client.</span></code><code class="sig-name descname"><span class="pre">Operation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Operation</span></code> class provides methods to retrieve privilege information
|
||||
of an operation element.</p>
|
||||
<p>An operation element is said to contain privilege information if there are
|
||||
any privileges assigned to the operation element or if one of the parameter
|
||||
elements contained in it has privileges assigned in privilege definition
|
||||
file.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.Operation.RESOURCE_TYPE">
|
||||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.operation'</span></em><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for operation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.Operation.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves the privilege information about an operation element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> contained in the service element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.privilege_client.OperationInfo" title="com.vmware.vapi.metadata.privilege_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege_client.OperationInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The
|
||||
<a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.privilege_client.OperationInfo" title="com.vmware.vapi.metadata.privilege_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege_client.OperationInfo</span></code></a>
|
||||
instance that corresponds to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not
|
||||
exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
exist.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
have any privilege information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.Operation.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the identifiers for the operation elements contained in the
|
||||
service element corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code> that have privilege
|
||||
information.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.list" title="com.vmware.vapi.metadata.privilege.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>List of identifiers for the operation elements contained in the
|
||||
service element that have privilege information.
|
||||
The return value will contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not have
|
||||
any operation elements that have privilege information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata.privilege.service_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -187,8 +187,699 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-certificate-management-vcenter-client-module">
|
||||
<h2>com.vmware.vcenter.certificate_management.vcenter_client module<a class="headerlink" href="#com-vmware-vcenter-certificate-management-vcenter-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.certificate_management.vcenter_client">
|
||||
<span id="com-vmware-vcenter-certificate-management-vcenter-client-module"></span><h2>com.vmware.vcenter.certificate_management.vcenter_client module<a class="headerlink" href="#module-com.vmware.vcenter.certificate_management.vcenter_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management.vcenter_client</span></code> module
|
||||
provides classes to manage certificates.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.certificate_management.vcenter_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.certificate_management.vcenter_client.</span></code><code class="sig-name descname"><span class="pre">Tls</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Tls</span></code> interface provides methods to replace Tls certificate. This
|
||||
class was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serial_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signature_algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer_dn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid_from</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid_to</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_dn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_ca</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_length_constraint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_usage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extended_key_usage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_alternative_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authority_information_access_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.Info</span></code> class contains information from a TLS certificate. This
|
||||
class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version (version number) value from the certificate. This attribute
|
||||
was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>serial_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SerialNumber value from the certificate. This attribute was added
|
||||
in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>signature_algorithm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Signature algorithm name from the certificate. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>issuer_dn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Issuer (issuer distinguished name) value from the certificate. This
|
||||
attribute was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>valid_from</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – validFrom specify the start date of the certificate. This attribute
|
||||
was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>valid_to</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – validTo specify the end date of the certificate. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>subject_dn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Subject (subject distinguished name) value from the certificate.
|
||||
This attribute was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Thumbprint value from the certificate. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>is_ca</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Certificate constraints isCA from the critical BasicConstraints
|
||||
extension, (OID = 2.5.29.19). This attribute was added in vSphere
|
||||
API 6.7.2.</p></li>
|
||||
<li><p><strong>path_length_constraint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Certificate constraints path length from the critical
|
||||
BasicConstraints extension, (OID = 2.5.29.19). This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>key_usage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection of keyusage contained in the certificate. This attribute
|
||||
was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>extended_key_usage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection of extended keyusage that contains details for which the
|
||||
certificate can be used for. This attribute was added in vSphere
|
||||
API 6.7.2.</p></li>
|
||||
<li><p><strong>subject_alternative_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection of subject alternative names. This attribute was added
|
||||
in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>authority_information_access_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection of authority information access URI. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>cert</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – TLS certificate in PEM format. This attribute was added in vSphere
|
||||
API 6.7.2.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ReplaceSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">common_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">organization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">organization_unit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_or_province</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">country</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_alt_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.ReplaceSpec</span></code> class contains information to generate a Private
|
||||
Key , CSR and hence VMCA signed machine SSL. This class was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The size of the key to be used for public and private key
|
||||
generation. This attribute was added in vSphere API 6.7.2.
|
||||
If None the key size will be ‘2048’.</p></li>
|
||||
<li><p><strong>common_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The common name of the host for which certificate is generated.
|
||||
This attribute was added in vSphere API 6.7.2.
|
||||
If None will default to PNID of host.</p></li>
|
||||
<li><p><strong>organization</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization field in certificate subject. This attribute was added
|
||||
in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>organization_unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization unit field in certificate subject. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>locality</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Locality field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>state_or_province</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – State field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>country</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Country field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>email_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Email field in Certificate extensions. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>subject_alt_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SubjectAltName is list of Dns Names and Ip addresses. This
|
||||
attribute was added in vSphere API 6.7.2.
|
||||
If None PNID of host will be used as IPAddress or Hostname for
|
||||
certificate generation .</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.Spec</span></code> class contains information for a Certificate and Private
|
||||
Key. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cert</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate string in PEM format. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Private key string in PEM format. This attribute was added in
|
||||
vSphere API 6.7.2.
|
||||
If None the private key from the certificate store will be used. It
|
||||
is required when replacing the certificate with a third party
|
||||
signed certificate.</p></li>
|
||||
<li><p><strong>root_cert</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Third party Root CA certificate in PEM format. This attribute was
|
||||
added in vSphere API 6.9.1.
|
||||
If None the new third party root CA certificate will not be added
|
||||
to the trust store. It is required when replacing the certificate
|
||||
with a third party signed certificate if the root certificate of
|
||||
the third party is not already a trusted root.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the rhttpproxy TLS certificate. This method was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>TLS certificate.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the rhttpproxy certificate is not present in VECS store.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if failed due to generic exception.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.renew">
|
||||
<code class="sig-name descname"><span class="pre">renew</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">duration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.renew" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Renews the TLS certificate for the given duration period.</p>
|
||||
<p>After this method completes, the services using the certificate will be
|
||||
restarted for the new certificate to take effect.. This method was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>duration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The duration (in days) of the new TLS certificate. The duration
|
||||
should be less than or equal to 730 days.
|
||||
If None, the duration will be 730 days (two years).</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
If the TLS certificate is not VMCA generated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
If the duration period specified is invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If the system failed to renew the TLS certificate.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.replace_vmca_signed">
|
||||
<code class="sig-name descname"><span class="pre">replace_vmca_signed</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.replace_vmca_signed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Replace MACHINE SSL with VMCA signed one with the given Spec.The system
|
||||
will go for restart.</p>
|
||||
<p>After this method completes, the services using the certificate will be
|
||||
restarted for the new certificate to take effect.. This method was
|
||||
added in vSphere API 6.9.1.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.ReplaceSpec</span></code></a>) – The information needed to generate VMCA signed Machine SSL</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
If the Spec given is not complete or invalid</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If the system failed to replace the machine ssl certificate</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.set">
|
||||
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Replaces the rhttpproxy TLS certificate with the specified certificate.
|
||||
This method can be used in three scenarios :</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>When the CSR is created and the private key is already stored, this
|
||||
method can replace the certificate. The <code class="xref py py-attr docutils literal notranslate"><span class="pre">Tls.Spec.cert</span></code> (but not
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Tls.Spec.key</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">Tls.Spec.root_cert</span></code>) must be provided
|
||||
as input.</p></li>
|
||||
<li><p>When the certificate is signed by a third party certificate
|
||||
authority/VMCA and the root certificate of the third party certificate
|
||||
authority/VMCA is already one of the trusted roots in the trust store,
|
||||
this method can replace the certificate and private key. The
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Tls.Spec.cert</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">Tls.Spec.key</span></code> (but not
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Tls.Spec.root_cert</span></code>) must be provided as input.</p></li>
|
||||
<li><p>When the certificate is signed by a third party certificate
|
||||
authority and the root certificate of the third party certificate
|
||||
authority is not one of the trusted roots in the trust store, this
|
||||
method can replace the certificate, private key and root CA
|
||||
certificate. The <code class="xref py py-attr docutils literal notranslate"><span class="pre">Tls.Spec.cert</span></code>,:attr:<cite>Tls.Spec.key</cite> and
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Tls.Spec.root_cert</span></code> must be provided as input.</p></li>
|
||||
</ol>
|
||||
<p>After this method completes, the services using the certificate will be
|
||||
restarted for the new certificate to take effect.</p>
|
||||
<p>The above three scenarios are only supported from vsphere 7.0 onwards..
|
||||
This method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.Spec</span></code></a>) – The information needed to replace the TLS certificate.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If the private key is not present in the VECS store.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||||
If the specified certificate thumbprint is the same as the existing
|
||||
TLS certificate thumbprint.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If the system failed to replace the TLS certificate.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.certificate_management.vcenter_client.</span></code><code class="sig-name descname"><span class="pre">TlsCsr</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr</span></code> interface provides methods to generate certificate signing
|
||||
request. This class was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr.Info</span></code> class contains information for a Certificate signing
|
||||
request. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>csr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate Signing Request in PEM format. This attribute was added
|
||||
in vSphere API 6.7.2.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">common_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">organization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">organization_unit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_or_province</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">country</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_alt_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr.Spec</span></code> class contains information to generate a Private Key
|
||||
and CSR. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 6.7.2.
|
||||
keySize will take 2048 bits if not modified.</p></li>
|
||||
<li><p><strong>common_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 6.7.2.
|
||||
commonName will take PNID if not modified.</p></li>
|
||||
<li><p><strong>organization</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization field in certificate subject. This attribute was added
|
||||
in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>organization_unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization unit field in certificate subject. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>locality</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Locality field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>state_or_province</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – State field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>country</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Country field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>email_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Email field in Certificate extensions. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>subject_alt_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 6.7.2.
|
||||
subjectAltName is list of Dns Names and Ip addresses</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generates a CSR with the given Spec. This method was added in vSphere
|
||||
API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec" title="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsCsr.Spec</span></code></a>) – The information needed to create a CSR.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsCsr.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>A Certificate Signing Request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If CSR could not be created for given spec for a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.certificate_management.vcenter_client.</span></code><code class="sig-name descname"><span class="pre">TrustedRootChains</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains</span></code> interface provides methods to create, modify,
|
||||
delete and read trusted root certificate chains. This class was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.CreateSpec</span></code> class contains information to create a
|
||||
trusted root certificate chain. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cert_chain</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.certificate_management_client.X509CertChain" title="com.vmware.vcenter.certificate_management_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a>) – Certificate chain in base64 encoding. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier for this trusted root. Client can specify at
|
||||
creation as long as it is unique, otherwise one will be generated.
|
||||
An example of a client providing the identifier would be if this
|
||||
trusted root is associated with a VC trust. In this case the
|
||||
identifier would be the domain id. This attribute was added in
|
||||
vSphere API 6.7.2.
|
||||
A unique id will be generated if not given.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.Info</span></code> class contains information for a trusted
|
||||
root certificate chain. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>cert_chain</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.certificate_management_client.X509CertChain" title="com.vmware.vcenter.certificate_management_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a>) – A certificate chain in base64 encoding. This attribute was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.Summary</span></code> class contains a trusted root certificate
|
||||
chain summary suitable for UI presentation. This class was added in vSphere
|
||||
API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for chain. This attribute was added in vSphere
|
||||
API 6.7.2.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a new trusted root certificate chain from the CreateSpec. This
|
||||
method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.CreateSpec</span></code></a>) – The information needed to create a trusted root certificate chain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The unique identifier for the new trusted root chain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if authorization is not given to caller.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||||
if a trusted root certificate chain exists with id in given spec.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chain</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes trusted root certificate chain for a given identifier. This
|
||||
method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for a trusted root cert chain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if authorization is not given to caller.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a trusted root certificate chain does not exist for given id.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chain</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve a trusted root certificate chain for a given identifier. This
|
||||
method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for a trusted root cert chain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>TrustedRootChain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if authorization is not given to caller.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a trusted root certificate chain does not exist for given id.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns summary information for each trusted root certificate chain.
|
||||
This method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>List of trusted root certificate chains summaries.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if authorization is not given to caller.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.certificate_management.vcenter_client.</span></code><code class="sig-name descname"><span class="pre">VmcaRoot</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">VmcaRoot</span></code> interface provides methods to replace VMware Certificate
|
||||
Authority (VMCA) root certificate. This class was added in vSphere API
|
||||
6.9.1.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">common_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">organization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">organization_unit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_or_province</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">country</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_alt_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">VmcaRoot.CreateSpec</span></code> contains information. to generate a Private Key
|
||||
and CSR. This class was added in vSphere API 6.9.1.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The size of the key to be used for public and private key
|
||||
generation. This attribute was added in vSphere API 6.9.1.
|
||||
If None the key size will be 2048.</p></li>
|
||||
<li><p><strong>common_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The common name of the host for which certificate is generated.
|
||||
This attribute was added in vSphere API 6.9.1.
|
||||
If None the common name will be the primary network identifier
|
||||
(PNID) of the vCenter Virtual Server Appliance (VCSA).</p></li>
|
||||
<li><p><strong>organization</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Organization field in certificate subject. This attribute was added
|
||||
in vSphere API 6.9.1.
|
||||
If None the organization will be ‘VMware’.</p></li>
|
||||
<li><p><strong>organization_unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Organization unit field in certificate subject. This attribute was
|
||||
added in vSphere API 6.9.1.
|
||||
If None the organization unit will be ‘VMware Engineering’.</p></li>
|
||||
<li><p><strong>locality</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Locality field in certificate subject. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
If None the locality will be ‘Palo Alto’.</p></li>
|
||||
<li><p><strong>state_or_province</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – State field in certificate subject. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
If None the state will be ‘California’.</p></li>
|
||||
<li><p><strong>country</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Country field in certificate subject. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
If None the country will be ‘US’.</p></li>
|
||||
<li><p><strong>email_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Email field in Certificate extensions. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
If None the emailAddress will be ‘email\@acme.com’.</p></li>
|
||||
<li><p><strong>subject_alt_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SubjectAltName is list of Dns Names and Ip addresses. This
|
||||
attribute was added in vSphere API 6.9.1.
|
||||
If None PNID of host will be used as IPAddress or Hostname for
|
||||
certificate generation.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Replace Root Certificate with VMCA signed one using the given Spec.</p>
|
||||
<p>After this method completes, the services using the certificate will be
|
||||
restarted for the new certificate to take effect.. This method was
|
||||
added in vSphere API 6.9.1.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmcaRoot.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The information needed to generate VMCA signed Root Certificate.
|
||||
Default values will be set for all null parameters.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If the system failed to renew the TLS certificate.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -196,7 +196,7 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-vmotion-client-module">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -206,18 +206,18 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-cluster-scale-in-ignore-vm-capabilities-client-module">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-disable-drs-vmotion-client-module">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-host-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-host-anti-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-vm-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-vm-anti-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#com-vmware-vcenter-compute-policies-capabilities-client-module">com.vmware.vcenter.compute.policies.capabilities_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#module-com.vmware.vcenter.compute.policies.capabilities_client">com.vmware.vcenter.compute.policies.capabilities_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -226,8 +226,685 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-compute-policies-client-module">
|
||||
<h2>com.vmware.vcenter.compute.policies_client module<a class="headerlink" href="#com-vmware-vcenter-compute-policies-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.compute.policies_client">
|
||||
<span id="com-vmware-vcenter-compute-policies-client-module"></span><h2>com.vmware.vcenter.compute.policies_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client</span></code> module provides classes for
|
||||
managing compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on
|
||||
AWS is not supported.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">Capabilities</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Capabilities</span></code> class provides methods to manage compute policy
|
||||
capabilities in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is
|
||||
not supported. The description of the capability provides information about
|
||||
the intent of a policy based on this capability. A capability provides a
|
||||
type to create a policy (see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>). A capability
|
||||
also provides a type that describes the information returned when
|
||||
retrieving information about a policy (see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>). <strong>Warning:</strong> This
|
||||
class is available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature. Since this
|
||||
can change based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production environments.
|
||||
Some Technology Preview APIs might only be applicable to specific
|
||||
environments.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">create_spec_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Capabilities.Info</span></code> class contains information about a compute policy
|
||||
capability. <strong>Warning:</strong> This class is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide feedback
|
||||
on the feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
|
||||
Technology Preview. These are early access APIs provided to test,
|
||||
automate and provide feedback on the feature. Since this can change
|
||||
based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable
|
||||
to specific environments.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the capability. <strong>Warning:</strong> This attribute is
|
||||
available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p></li>
|
||||
<li><p><strong>create_spec_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the class used to create a policy based on this
|
||||
capability. See
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>.
|
||||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback,
|
||||
VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||||
<li><p><strong>info_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the class returned when retrieving information about
|
||||
a policy based on this capability. See
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>.
|
||||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback,
|
||||
VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.RESOURCE_TYPE">
|
||||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.compute.policies.Capability'</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The resource type for the compute policy capability. <strong>Warning:</strong> This class
|
||||
attribute is available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature. Since this can
|
||||
change based on feedback, VMware does not guarantee backwards compatibility and
|
||||
recommends against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Capabilities.Summary</span></code> class contains commonly used information about
|
||||
a compute policy capability. <strong>Warning:</strong> This class is available as
|
||||
Technology Preview. These are early access APIs provided to test, automate
|
||||
and provide feedback on the feature. Since this can change based on
|
||||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology Preview APIs
|
||||
might only be applicable to specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability. <strong>Warning:</strong> This attribute is
|
||||
available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
|
||||
Technology Preview. These are early access APIs provided to test,
|
||||
automate and provide feedback on the feature. Since this can change
|
||||
based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable
|
||||
to specific environments.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the capability. <strong>Warning:</strong> This attribute is
|
||||
available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capability</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about a specific compute policy capability in
|
||||
VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
|
||||
<strong>Warning:</strong> This method is available as Technology Preview. These are
|
||||
early access APIs provided to test, automate and provide feedback on
|
||||
the feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability for which information should be
|
||||
retrieved.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info" title="com.vmware.vcenter.compute.policies_client.Capabilities.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Capabilities.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Detailed information about the capability.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a capability with this identifier does not exist.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user doesn’t have the required privileges, or when used
|
||||
beyond VMware Cloud on AWS.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about the compute policy capabilities available in
|
||||
this vCenter server in VMware Cloud on AWS. Usage beyond VMware Cloud
|
||||
on AWS is not supported. <strong>Warning:</strong> This method is available as
|
||||
Technology Preview. These are early access APIs provided to test,
|
||||
automate and provide feedback on the feature. Since this can change
|
||||
based on feedback, VMware does not guarantee backwards compatibility
|
||||
and recommends against using them in production environments. Some
|
||||
Technology Preview APIs might only be applicable to specific
|
||||
environments.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.list" title="com.vmware.vcenter.compute.policies_client.Capabilities.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary" title="com.vmware.vcenter.compute.policies_client.Capabilities.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Capabilities.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>The list of compute policy capabilities available on this vCenter
|
||||
server.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user doesn’t have the required privileges, or when used
|
||||
beyond VMware Cloud on AWS.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.CreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> class contains common information used to create a new
|
||||
policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not
|
||||
supported. <strong>Warning:</strong> This class is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide feedback
|
||||
on the feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as Technology Preview. These are early
|
||||
access APIs provided to test, automate and provide feedback on the
|
||||
feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them
|
||||
in production environments. Some Technology Preview APIs might only
|
||||
be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
server. <strong>Warning:</strong> This attribute is available as Technology
|
||||
Preview. These are early access APIs provided to test, automate and
|
||||
provide feedback on the feature. Since this can change based on
|
||||
feedback, VMware does not guarantee backwards compatibility and
|
||||
recommends against using them in production environments. Some
|
||||
Technology Preview APIs might only be applicable to specific
|
||||
environments.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as Technology Preview. These are early access APIs provided to
|
||||
test, automate and provide feedback on the feature. Since this can
|
||||
change based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable
|
||||
to specific environments.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.CreateSpec.capability">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the discriminator value</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains common information about a compute policy in
|
||||
VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
|
||||
<strong>Warning:</strong> This class is available as Technology Preview. These are early
|
||||
access APIs provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable to
|
||||
specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
Technology Preview. These are early access APIs provided to test,
|
||||
automate and provide feedback on the feature. Since this can change
|
||||
based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable
|
||||
to specific environments.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as Technology Preview. These are early access APIs provided to
|
||||
test, automate and provide feedback on the feature. Since this can
|
||||
change based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable
|
||||
to specific environments.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as Technology Preview. These are early
|
||||
access APIs provided to test, automate and provide feedback on the
|
||||
feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them
|
||||
in production environments. Some Technology Preview APIs might only
|
||||
be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Info.capability">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the discriminator value</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">ObjectCompliance</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ObjectCompliance</span></code> class defines the compliance states a policy can
|
||||
be in on a particular object in VMware Cloud on AWS. Usage beyond VMware
|
||||
Cloud on AWS is not supported. <strong>Warning:</strong> This enumeration is available
|
||||
as Technology Preview. These are early access APIs provided to test,
|
||||
automate and provide feedback on the feature. Since this can change based
|
||||
on feedback, VMware does not guarantee backwards compatibility and
|
||||
recommends against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance" title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectCompliance</span></code></a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.COMPLIANT">
|
||||
<code class="sig-name descname"><span class="pre">COMPLIANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjectCompliance(string='COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The policy is in compliance on the object. <strong>Warning:</strong> This class
|
||||
attribute is available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature. Since this
|
||||
can change based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production environments.
|
||||
Some Technology Preview APIs might only be applicable to specific
|
||||
environments.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_APPLICABLE">
|
||||
<code class="sig-name descname"><span class="pre">NOT_APPLICABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjectCompliance(string='NOT_APPLICABLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The object is in a state for which the policy does not apply. <strong>Warning:</strong>
|
||||
This class attribute is available as Technology Preview. These are early
|
||||
access APIs provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable to
|
||||
specific environments.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_COMPLIANT">
|
||||
<code class="sig-name descname"><span class="pre">NOT_COMPLIANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjectCompliance(string='NOT_COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The policy is not in compliance on the object. <strong>Warning:</strong> This class
|
||||
attribute is available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature. Since this
|
||||
can change based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production environments.
|
||||
Some Technology Preview APIs might only be applicable to specific
|
||||
environments.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.UNKNOWN">
|
||||
<code class="sig-name descname"><span class="pre">UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjectCompliance(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The object has an unknown compliance state. <strong>Warning:</strong> This class
|
||||
attribute is available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature. Since this
|
||||
can change based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production environments.
|
||||
Some Technology Preview APIs might only be applicable to specific
|
||||
environments.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Status">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Status</span></code> class describes the current status of a compute policy in
|
||||
VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
|
||||
<strong>Warning:</strong> This class is available as Technology Preview. These are early
|
||||
access APIs provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable to
|
||||
specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance" title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectCompliance</span></code></a>) – The compliance status of the policy on a specified object.
|
||||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback,
|
||||
VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">TagUsage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TagUsage</span></code> class provides methods to query which tags are used by
|
||||
policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not
|
||||
supported. <strong>Warning:</strong> This class is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide feedback
|
||||
on the feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing the tags used by policies as available in this vCenter
|
||||
server (see <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="com.vmware.vcenter.compute.policies_client.TagUsage.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">TagUsage.list()</span></code></a>). If multiple attributes are specified,
|
||||
only the tags used by policies that match an element of each attribute
|
||||
match the filter. <strong>Warning:</strong> This class is available as Technology
|
||||
Preview. These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback, VMware
|
||||
does not guarantee backwards compatibility and recommends against using
|
||||
them in production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers that compute policies must have to match the filter.
|
||||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback,
|
||||
VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will contain
|
||||
identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.
|
||||
If None or empty, then tags used by any policy match this filter.</p></li>
|
||||
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers that tags must have to match the filter. <strong>Warning:</strong>
|
||||
This attribute is available as Technology Preview. These are early
|
||||
access APIs provided to test, automate and provide feedback on the
|
||||
feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them
|
||||
in production environments. Some Technology Preview APIs might only
|
||||
be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will contain identifiers for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.
|
||||
If None or empty, then tags with any tag identifier match this
|
||||
filter.</p></li>
|
||||
<li><p><strong>tag_types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers that tag types must have to match the filter.
|
||||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback,
|
||||
VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will contain identifiers for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.
|
||||
If None or empty, then tags of any type match this filter.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TagUsage.Summary</span></code> class contains common information about a tag used
|
||||
by a policy. <strong>Warning:</strong> This class is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide feedback
|
||||
on the feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the policy that uses the tag indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.tag</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p></li>
|
||||
<li><p><strong>tag_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the tag type used by the policy indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.</p></li>
|
||||
<li><p><strong>tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the tag used by the policy indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">tagType</span></code> must contain the actual resource type. When
|
||||
methods return a value of this class as a return value, the
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">tagType</span></code> will contain the actual resource type.</p></li>
|
||||
<li><p><strong>tag_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the tag used by the policy indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as Technology Preview. These are early access APIs
|
||||
provided to test, automate and provide feedback on the feature.
|
||||
Since this can change based on feedback, VMware does not guarantee
|
||||
backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p></li>
|
||||
<li><p><strong>category_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the category that has <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.tag</span></code>.
|
||||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback,
|
||||
VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about the tags used by policies available in this
|
||||
vCenter server matching the <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a> in VMware
|
||||
Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
|
||||
<strong>Warning:</strong> This method is available as Technology Preview. These are
|
||||
early access APIs provided to test, automate and provide feedback on
|
||||
the feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification for matching tags used by policies.
|
||||
If None, the behavior is equivalent to a
|
||||
<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a> with all attributes None, which means
|
||||
all tags used by policies match the filter.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="com.vmware.vcenter.compute.policies_client.TagUsage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary" title="com.vmware.vcenter.compute.policies_client.TagUsage.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The list of tags used by policies available on this vCenter server
|
||||
matching the <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user doesn’t have the required privileges, or when used
|
||||
beyond VMware Cloud on AWS.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -195,8 +195,184 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-vmotion-client-module">
|
||||
<h2>com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module<a class="headerlink" href="#com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-vmotion-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client">
|
||||
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-vmotion-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client</span></code>
|
||||
module provides classes for the virtual machine evacuation vMotion capability
|
||||
offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is
|
||||
not supported.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> class contains information used to create a new vMotion
|
||||
policy that applies when a host is evacuated, see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>, in VMware Cloud
|
||||
on AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual
|
||||
machines that share the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be
|
||||
vMotioned from a host whenever the host is evacuated by vCenter. If vCenter
|
||||
cannot migrate a virtual machine, then it will remain running on its
|
||||
current host. <strong>Warning:</strong> This class is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide feedback
|
||||
on the feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be vMotioned from a host if
|
||||
vCenter requires to evacuate the host. If vMotion is not feasible,
|
||||
then the virtual machine will remain running on its current host.
|
||||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback,
|
||||
VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as Technology Preview. These are early
|
||||
access APIs provided to test, automate and provide feedback on the
|
||||
feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them
|
||||
in production environments. Some Technology Preview APIs might only
|
||||
be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
server. <strong>Warning:</strong> This attribute is available as Technology
|
||||
Preview. These are early access APIs provided to test, automate and
|
||||
provide feedback on the feature. Since this can change based on
|
||||
feedback, VMware does not guarantee backwards compatibility and
|
||||
recommends against using them in production environments. Some
|
||||
Technology Preview APIs might only be applicable to specific
|
||||
environments.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as Technology Preview. These are early access APIs provided to
|
||||
test, automate and provide feedback on the feature. Since this can
|
||||
change based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable
|
||||
to specific environments.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec.capability">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the discriminator value</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains information about a vMotion policy that applies
|
||||
when a host is evacuated, see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>, in VMware Cloud on
|
||||
AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual
|
||||
machines that share the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> will be
|
||||
vMotioned from a host whenever the host is evacuated by vCenter. If vCenter
|
||||
cannot migrate a virtual machine, then it will remain running on its
|
||||
current host. <strong>Warning:</strong> This class is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide feedback
|
||||
on the feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them in
|
||||
production environments. Some Technology Preview APIs might only be
|
||||
applicable to specific environments.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be vMotioned from a host if
|
||||
vCenter requires to evacuate the host. If vMotion is not feasible,
|
||||
then the virtual machine will remain running on its current host.
|
||||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||||
These are early access APIs provided to test, automate and provide
|
||||
feedback on the feature. Since this can change based on feedback,
|
||||
VMware does not guarantee backwards compatibility and recommends
|
||||
against using them in production environments. Some Technology
|
||||
Preview APIs might only be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
Technology Preview. These are early access APIs provided to test,
|
||||
automate and provide feedback on the feature. Since this can change
|
||||
based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable
|
||||
to specific environments.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as Technology Preview. These are early access APIs provided to
|
||||
test, automate and provide feedback on the feature. Since this can
|
||||
change based on feedback, VMware does not guarantee backwards
|
||||
compatibility and recommends against using them in production
|
||||
environments. Some Technology Preview APIs might only be applicable
|
||||
to specific environments.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as Technology Preview. These are early
|
||||
access APIs provided to test, automate and provide feedback on the
|
||||
feature. Since this can change based on feedback, VMware does not
|
||||
guarantee backwards compatibility and recommends against using them
|
||||
in production environments. Some Technology Preview APIs might only
|
||||
be applicable to specific environments.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info.capability">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the discriminator value</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -196,7 +196,7 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-vmotion-client-module">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -196,7 +196,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-vmotion-client-module">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -206,12 +206,12 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-cluster-scale-in-ignore-vm-capabilities-client-module">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-disable-drs-vmotion-client-module">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-host-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-host-anti-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-vm-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#com-vmware-vcenter-compute-policies-capabilities-vm-vm-anti-affinity-client-module">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -220,8 +220,23 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-compute-policies-capabilities-client-module">
|
||||
<h2>com.vmware.vcenter.compute.policies.capabilities_client module<a class="headerlink" href="#com-vmware-vcenter-compute-policies-capabilities-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities_client">
|
||||
<span id="com-vmware-vcenter-compute-policies-capabilities-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities_client</span></code> module provides
|
||||
classes for compute policy capabilities offered by vCenter in VMware Cloud on
|
||||
AWS. Usage beyond VMware Cloud on AWS is not supported.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -190,7 +190,7 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.content.registries.html">com.vmware.vcenter.content.registries package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#com-vmware-vcenter-content-registries-harbor-client-module">com.vmware.vcenter.content.registries.harbor_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#module-com.vmware.vcenter.content.registries.harbor_client">com.vmware.vcenter.content.registries.harbor_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -199,8 +199,619 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-content-registries-client-module">
|
||||
<h2>com.vmware.vcenter.content.registries_client module<a class="headerlink" href="#com-vmware-vcenter-content-registries-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.content.registries_client">
|
||||
<span id="com-vmware-vcenter-content-registries-client-module"></span><h2>com.vmware.vcenter.content.registries_client module<a class="headerlink" href="#module-com.vmware.vcenter.content.registries_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.registries_client</span></code> module provides classes
|
||||
and classes for managing image registries in vCenter.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.DayOfWeek">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></code><code class="sig-name descname"><span class="pre">DayOfWeek</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">DayOfWeek</span></code> class describes the supported days of the week to run a
|
||||
specific operation for a container registry.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.content.registries_client.DayOfWeek" title="com.vmware.vcenter.content.registries_client.DayOfWeek"><code class="xref py py-class docutils literal notranslate"><span class="pre">DayOfWeek</span></code></a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.DayOfWeek.FRIDAY">
|
||||
<code class="sig-name descname"><span class="pre">FRIDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='FRIDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.FRIDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Friday.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.DayOfWeek.MONDAY">
|
||||
<code class="sig-name descname"><span class="pre">MONDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='MONDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.MONDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Monday.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.DayOfWeek.SATURDAY">
|
||||
<code class="sig-name descname"><span class="pre">SATURDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='SATURDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.SATURDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Saturday.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.DayOfWeek.SUNDAY">
|
||||
<code class="sig-name descname"><span class="pre">SUNDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='SUNDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.SUNDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sunday.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.DayOfWeek.THURSDAY">
|
||||
<code class="sig-name descname"><span class="pre">THURSDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='THURSDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.THURSDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Thursday.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.DayOfWeek.TUESDAY">
|
||||
<code class="sig-name descname"><span class="pre">TUESDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='TUESDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.TUESDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tuesday.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.DayOfWeek.WEDNESDAY">
|
||||
<code class="sig-name descname"><span class="pre">WEDNESDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='WEDNESDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Wednesday.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></code><code class="sig-name descname"><span class="pre">Harbor</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor</span></code> class provides methods to manage the lifecycle of an
|
||||
integrated Harbor container registry in vCenter.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.CreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">garbage_collection</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor.CreateSpec</span></code> class contains the specification required to
|
||||
create a Harbor registry.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the cluster hosting the registry.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
||||
If None, registry will not be created on a specified cluster. This
|
||||
is required in current version, since Harbor can only be created on
|
||||
a cluster with Kubernetes enabled.</p></li>
|
||||
<li><p><strong>garbage_collection</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection" title="com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.GarbageCollection</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Garbage collection configuration for the Harbor registry.
|
||||
If None, a default configuration is set, Recurrence#WEEKLY,
|
||||
DayOfWeek#SATURDAY, GarbageCollection#hour is 2,
|
||||
GarbageCollection#minute is 0.</p></li>
|
||||
<li><p><strong>storage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.StorageSpec" title="com.vmware.vcenter.content.registries_client.Harbor.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.StorageSpec</span></code></a>) – Storage associated with the Harbor registry. The list contains only
|
||||
one storage backing in this version.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">GarbageCollection</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">day_of_week</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hour</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minute</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor.GarbageCollection</span></code> class contains garbage collection
|
||||
configuration for the Harbor registry.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence" title="com.vmware.vcenter.content.registries_client.Recurrence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Recurrence</span></code></a>) – Frequency of garbage collection.</p></li>
|
||||
<li><p><strong>day_of_week</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.DayOfWeek" title="com.vmware.vcenter.content.registries_client.DayOfWeek"><code class="xref py py-class docutils literal notranslate"><span class="pre">DayOfWeek</span></code></a>) – Day of the week when garbage collection should run.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY" title="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.WEEKLY</span></code></a>.</p></li>
|
||||
<li><p><strong>hour</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Hour at which garbage collection should run.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence.DAILY" title="com.vmware.vcenter.content.registries_client.Recurrence.DAILY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.DAILY</span></code></a> or
|
||||
<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY" title="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.WEEKLY</span></code></a>.</p></li>
|
||||
<li><p><strong>minute</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minute at which garbage collection should run.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence.DAILY" title="com.vmware.vcenter.content.registries_client.Recurrence.DAILY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.DAILY</span></code></a> or
|
||||
<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY" title="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.WEEKLY</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">creation_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ui_access_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">garbage_collection</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor.Info</span></code> class contains detailed information about a running
|
||||
Harbor registry.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the cluster.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
||||
If None, container registry is not created on the cluster specified
|
||||
by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Harbor.CreateSpec.cluster</span></code>.</p></li>
|
||||
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the Harbor namespace in case it is created in a
|
||||
Kubernetes environment.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">NamespaceInstance</span></code>. When methods return a value of this class as
|
||||
a return value, the attribute will be an identifier for the
|
||||
resource type: <code class="docutils literal notranslate"><span class="pre">NamespaceInstance</span></code>.
|
||||
If None, no Kubernetes namespace is created for the Harbor.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the registry.</p></li>
|
||||
<li><p><strong>creation_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when the harbor registry was created.</p></li>
|
||||
<li><p><strong>ui_access_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL to access the UI of the registry.</p></li>
|
||||
<li><p><strong>cert_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Harbor certificate chain in base64 format.</p></li>
|
||||
<li><p><strong>garbage_collection</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection" title="com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.GarbageCollection</span></code></a>) – Garbage collection information for the registry.</p></li>
|
||||
<li><p><strong>storage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.StorageInfo" title="com.vmware.vcenter.content.registries_client.Harbor.StorageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.StorageInfo</span></code></a>) – Storage information associated with the registry.</p></li>
|
||||
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Health.Info" title="com.vmware.vcenter.content.registries_client.Health.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Health.Info</span></code></a>) – Health status of the container registry.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.StorageInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">StorageInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.StorageInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor.StorageInfo</span></code> class contains the detailed information about
|
||||
storage used by the Harbor registry.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the storage policy.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
|
||||
a return value, the attribute will be an identifier for the
|
||||
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p></li>
|
||||
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total capacity for the registry storage (in mebibytes). This is the
|
||||
storage limit set on the Harbor registry. If a storage limit was
|
||||
not set on the registry, the default registry capacity - 204800
|
||||
mebibytes is used.</p></li>
|
||||
<li><p><strong>used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Overall storage used by the registry (in mebibytes). This is the
|
||||
sum of used storage associated with storage policies configured for
|
||||
the registry.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.StorageSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">StorageSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.StorageSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor.StorageSpec</span></code> class contains the specification required to
|
||||
configure storage associated with a Harbor registry. In this version,
|
||||
Harbor registry is created in Kubernetes environment, information in this
|
||||
class will result in storage quotas on a Kubernetes namespace.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the storage policy.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
|
||||
a return value, the attribute will be an identifier for the
|
||||
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The maximum amount of storage (in mebibytes) which can be utilized
|
||||
by the registry for this specification.
|
||||
If None, a default limit of 204800 mebibytes will be set as the
|
||||
registry’s storage capacity.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">registry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ui_access_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor.Summary</span></code> class contains basic information about a running
|
||||
Harbor registry.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the cluster.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
||||
If None, container registry is not created on the cluster specified
|
||||
by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Harbor.CreateSpec.cluster</span></code>.</p></li>
|
||||
<li><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>. When methods return a
|
||||
value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the registry.</p></li>
|
||||
<li><p><strong>ui_access_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL to access the UI of the registry.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a Harbor registry in the cluster.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A unique token generated on the client for each creation request.
|
||||
The token should be a universally unique identifier (UUID), for
|
||||
example: <code class="docutils literal notranslate"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
|
||||
be used to guarantee idempotent creation.
|
||||
If not specified, creation is not idempotent.</p></li>
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.CreateSpec" title="com.vmware.vcenter.content.registries_client.Harbor.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.CreateSpec</span></code></a>) – Specification for creating the Harbor registry.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Identifier of the deployed registry.
|
||||
The return value will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||||
if a Harbor already exists in the associated cluster.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if resources/objects could not be located.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Harbor.CreateSpec.cluster</span></code> does not have vSphere
|
||||
namespace enabled.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have ContentLibrary.ManageRegistry and/or
|
||||
CertificateAuthority.Manage privilege, or user does not have
|
||||
ContentLibrary.ManageClusterRegistryResource privilege on
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Harbor.CreateSpec.cluster</span></code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete the Harbor registry in the cluster. All Harbor projects,
|
||||
repositories and images will be deleted upon Harbor registry deletion.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a registry specified by <code class="docutils literal notranslate"><span class="pre">registry</span></code> could not be found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have ContentLibrary.ManageRegistry privilege.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get detailed information of the Harbor registry.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.Info" title="com.vmware.vcenter.content.registries_client.Harbor.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the registry.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a Harbor registry specified by <code class="docutils literal notranslate"><span class="pre">registry</span></code> could not be found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have System.Read privilege.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Harbor.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns basic information of all Harbor registries.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.list" title="com.vmware.vcenter.content.registries_client.Harbor.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.Summary" title="com.vmware.vcenter.content.registries_client.Harbor.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>The list of basic information of all Harbor registries.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have System.Read privilege.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></code><code class="sig-name descname"><span class="pre">Health</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Health</span></code> class provides methods to retrieve health status for a
|
||||
container registry.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Health.Info</span></code> class contains health information about a container
|
||||
registry.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Health.Status" title="com.vmware.vcenter.content.registries_client.Health.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Health.Status</span></code></a>) – Container registry status.</p></li>
|
||||
<li><p><strong>details</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Details about the status.
|
||||
If None, message details are not required for taking actions.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health.Status">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Health.Status</span></code> class describes the status of the container registry.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health.Status.DELETING">
|
||||
<code class="sig-name descname"><span class="pre">DELETING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='DELETING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.DELETING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Container registry is being deleted.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health.Status.ERROR">
|
||||
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Container registry failed to start or stopped with fatal error.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health.Status.RUNNING">
|
||||
<code class="sig-name descname"><span class="pre">RUNNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.RUNNING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Container registry is running.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health.Status.STARTING">
|
||||
<code class="sig-name descname"><span class="pre">STARTING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='STARTING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.STARTING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Container registry is starting.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health.Status.WARNING">
|
||||
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.WARNING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Container registry is running with some warning, for example, storage
|
||||
reaches the threshold configuration.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Health.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the health information of a container registry in the vCenter.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Health.Info" title="com.vmware.vcenter.content.registries_client.Health.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Health.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Health information of the registry.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the registry does not exist.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user is not a member of the Administrators</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Recurrence">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></code><code class="sig-name descname"><span class="pre">Recurrence</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Recurrence" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Recurrence</span></code> class defines the supported values for how often to run
|
||||
a specific operation for a container registry.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence" title="com.vmware.vcenter.content.registries_client.Recurrence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Recurrence</span></code></a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Recurrence.DAILY">
|
||||
<code class="sig-name descname"><span class="pre">DAILY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Recurrence(string='DAILY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Recurrence.DAILY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>An operation occurs on a daily basis.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Recurrence.NONE">
|
||||
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Recurrence(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Recurrence.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>No operation is scheduled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY">
|
||||
<code class="sig-name descname"><span class="pre">WEEKLY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Recurrence(string='WEEKLY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>An operation occurs on a weekly basis.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,8 +189,440 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-content-registries-harbor-client-module">
|
||||
<h2>com.vmware.vcenter.content.registries.harbor_client module<a class="headerlink" href="#com-vmware-vcenter-content-registries-harbor-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.content.registries.harbor_client">
|
||||
<span id="com-vmware-vcenter-content-registries-harbor-client-module"></span><h2>com.vmware.vcenter.content.registries.harbor_client module<a class="headerlink" href="#module-com.vmware.vcenter.content.registries.harbor_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.registries.harbor_client</span></code> module provides
|
||||
classes and classes for managing Harbor registry in vCenter.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries.harbor_client.</span></code><code class="sig-name descname"><span class="pre">Projects</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Projects</span></code> class provides methods for managing the lifecycle of
|
||||
Harbor project that stores and distributes container repositories and
|
||||
images.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfigStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Projects.ConfigStatus</span></code> class describes the status of reaching the
|
||||
desired configuration state for the Harbor project.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigStatus</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.ERROR">
|
||||
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Failed to create Harbor project or apply the configuration to the project,
|
||||
user intervention needed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.PENDING">
|
||||
<code class="sig-name descname"><span class="pre">PENDING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='PENDING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.PENDING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Harbor project is being created or the configuration is being applied to
|
||||
the project.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY">
|
||||
<code class="sig-name descname"><span class="pre">READY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='READY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Harbor project is created or configured correctly.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.REMOVING">
|
||||
<code class="sig-name descname"><span class="pre">REMOVING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='REMOVING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.REMOVING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The configuration is being removed and Harbor project is being deleted.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.CreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Projects.CreateSpec</span></code> class defines the information required to
|
||||
create a Harbor project.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Harbor project. Should be between 1-63 characters long
|
||||
alphanumeric string and may contain the following characters:
|
||||
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
|
||||
the ‘-‘ character allowed anywhere except the first or last
|
||||
character.</p></li>
|
||||
<li><p><strong>scope</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Scope</span></code></a>) – Access type of a Harbor project.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">creation_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Projects.Info</span></code> class contains detailed information about a Harbor
|
||||
project.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Harbor project. Should be between 1-63 characters long
|
||||
alphanumeric string and may contain the following characters:
|
||||
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
|
||||
the ‘-‘ character allowed anywhere except the first or last
|
||||
character.</p></li>
|
||||
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.ConfigStatus</span></code></a>) – The status of the Harbor project.</p></li>
|
||||
<li><p><strong>scope</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Scope</span></code></a>) – The access type of a Harbor project.</p></li>
|
||||
<li><p><strong>creation_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when the harbor project creation API was
|
||||
triggered and project identifier generated.</p></li>
|
||||
<li><p><strong>update_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when the harbor project purge API was triggered.
|
||||
In case no purge was triggered, <code class="docutils literal notranslate"><span class="pre">updateTime</span></code> is same as
|
||||
<code class="docutils literal notranslate"><span class="pre">creationTime</span></code>.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">configStatus</span></code> is <a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Projects.ConfigStatus.READY</span></code></a>.</p></li>
|
||||
<li><p><strong>access_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL to access the harbor project through docker client.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">configStatus</span></code> is <a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Projects.ConfigStatus.READY</span></code></a>.</p></li>
|
||||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Details about the ERROR project status.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">configStatus</span></code> is <a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.ERROR" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Projects.ConfigStatus.ERROR</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Scope</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Projects.Scope</span></code> class in a project defines access levels of the
|
||||
project.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Scope</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PRIVATE">
|
||||
<code class="sig-name descname"><span class="pre">PRIVATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Scope(string='PRIVATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PRIVATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A Harbor project can only be accessed by assigned users.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PUBLIC">
|
||||
<code class="sig-name descname"><span class="pre">PUBLIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Scope(string='PUBLIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PUBLIC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A Harbor project can be accessed by everyone.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Projects.Summary</span></code> class contains basic information about a Harbor
|
||||
project.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>project</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the harbor project.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</span></code>. When
|
||||
methods return a value of this class as a return value, the
|
||||
attribute will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Harbor project. Should be between 1-63 characters long
|
||||
alphanumeric string and may contain the following characters:
|
||||
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
|
||||
the ‘-‘ character allowed anywhere except the first or last
|
||||
character.</p></li>
|
||||
<li><p><strong>scope</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Scope</span></code></a>) – Access type of a Harbor project.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a project in a Harbor registry using the supplied
|
||||
specification. In vSphere 7.0, a Harbor registry is deployed in a
|
||||
vSphere cluster with vSphere namespaces enabled. When a namespace is
|
||||
created, a project with same name as the namespace is created in the
|
||||
Harbor registry, so this method should not be called.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Registry.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p></li>
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.CreateSpec" title="com.vmware.vcenter.content.registries.harbor_client.Projects.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.CreateSpec</span></code></a>) – Information used to create the Harbor project.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Identifier of the newly created Harbor project.
|
||||
The return value will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if Harbor registry is being deleted.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a registry specified by <code class="docutils literal notranslate"><span class="pre">registry</span></code> could not be found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||||
if a project with the same name already exists in the registry. In
|
||||
vSphere 7.0, the existing project could have been created
|
||||
automatically when a namespace with the same name is created.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have ContentLibrary.ManageRegistryProject
|
||||
privilege.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes the specified project from Harbor registry. Repositories and
|
||||
images in the project will be removed upon project deletion. Storage
|
||||
space of deleted images in the project will be reclaimed through next
|
||||
scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor
|
||||
registry is deployed in a vSphere cluster with vSphere namespaces
|
||||
enabled. When a namespace is deleted, a project with same name as the
|
||||
namespace is deleted from the Harbor registry, so this method should
|
||||
not be called.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p></li>
|
||||
<li><p><strong>project</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Harbor project.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if Harbor registry is being deleted.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if <code class="docutils literal notranslate"><span class="pre">registry</span></code> or <code class="docutils literal notranslate"><span class="pre">project</span></code> cannot be found. In vSphere 7.0, the
|
||||
existing project could have been deleted automatically when a
|
||||
namespace with the same name is deleted.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have ContentLibrary.ManageRegistryProject
|
||||
privilege.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns detailed information about the specified Harbor project.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p></li>
|
||||
<li><p><strong>project</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Harbor project.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Info" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Detailed information about the specified Harbor project.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if <code class="docutils literal notranslate"><span class="pre">registry</span></code> or <code class="docutils literal notranslate"><span class="pre">project</span></code> cannot be found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have System.Read privilege.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns basic information of all projects in a Harbor registry.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.list" title="com.vmware.vcenter.content.registries.harbor_client.Projects.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Summary" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The list of summary information of all Harbor projects.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if <code class="docutils literal notranslate"><span class="pre">registry</span></code> cannot be found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have System.Read privilege.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.purge">
|
||||
<code class="sig-name descname"><span class="pre">purge</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.purge" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove all repositories, images and members in the project. Storage
|
||||
space of deleted images in the project will be reclaimed through next
|
||||
scheduled Harbor registry garbage collection.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p></li>
|
||||
<li><p><strong>project</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Harbor project.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if <code class="docutils literal notranslate"><span class="pre">registry</span></code> or <code class="docutils literal notranslate"><span class="pre">project</span></code> cannot be found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if Harbor registry is being deleted or the project is not in
|
||||
<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Projects.ConfigStatus.READY</span></code></a> status.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have ContentLibrary.ManageRegistryProject
|
||||
privilege.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.content.registries.harbor_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries.harbor_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -189,8 +189,341 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-crypto-manager-hosts-kms-client-module">
|
||||
<h2>com.vmware.vcenter.crypto_manager.hosts.kms_client module<a class="headerlink" href="#com-vmware-vcenter-crypto-manager-hosts-kms-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.crypto_manager.hosts.kms_client">
|
||||
<span id="com-vmware-vcenter-crypto-manager-hosts-kms-client-module"></span><h2>com.vmware.vcenter.crypto_manager.hosts.kms_client module<a class="headerlink" href="#module-com.vmware.vcenter.crypto_manager.hosts.kms_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.hosts.kms_client</span></code> module provides
|
||||
classes for managing key providers.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager.hosts.kms_client.</span></code><code class="sig-name descname"><span class="pre">Providers</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers</span></code> class provides methods to retrieve providers on a host.
|
||||
This class was added in vSphere API 7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.FilterSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">providers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing providers. This class was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>providers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provider identifiers. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.
|
||||
If None or empty, the result will not be filtered by provider
|
||||
identifier.</p></li>
|
||||
<li><p><strong>health</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provider health status. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
If None or empty, the result will not be filtered by provider
|
||||
health status.</p></li>
|
||||
<li><p><strong>types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provider types. This attribute was added in vSphere API 7.0.2.0.
|
||||
If None or empty, the result will not be filtered by provider type.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Health</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Health</span></code> class contains the health status of a provider.
|
||||
This enumeration was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health.ERROR">
|
||||
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>There is a critical issue that requires attention. This class attribute was
|
||||
added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health.NONE">
|
||||
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>No health status is available. This class attribute was added in vSphere
|
||||
API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health.OK">
|
||||
<code class="sig-name descname"><span class="pre">OK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='OK')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health.OK" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Operating normally. This class attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health.WARNING">
|
||||
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health.WARNING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Operating normally, but there is an issue that requires attention. This
|
||||
class attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">native_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Info</span></code> class contains attributes that describe the details
|
||||
of a provider. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a>) – Health status of the provider. This attribute was added in vSphere
|
||||
API 7.0.2.0.</p></li>
|
||||
<li><p><strong>details</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Details regarding the health status of the provider. This attribute
|
||||
was added in vSphere API 7.0.2.0.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a>) – Provider type. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
||||
<li><p><strong>native_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.NativeProviderInfo" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.NativeProviderInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderInfo</span></code></a>) – Native provider information. This attribute was added in vSphere
|
||||
API 7.0.2.0.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.NativeProviderInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NativeProviderInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.NativeProviderInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.NativeProviderInfo</span></code> class contains attributes that
|
||||
describe details of a native provider. This class was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Key identifier for the provider. This attribute was added in
|
||||
vSphere API 7.0.2.0.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Summary</span></code> class contains attributes that describe a
|
||||
provider. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the provider. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a>) – Provider type. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
||||
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a>) – Health status of the provider. This attribute was added in vSphere
|
||||
API 7.0.2.0.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Type</span></code> class contains the types of providers. This
|
||||
enumeration was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type.NATIVE">
|
||||
<code class="sig-name descname"><span class="pre">NATIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='NATIVE')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type.NATIVE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Native provider. This class attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type.TRUST_AUTHORITY">
|
||||
<code class="sig-name descname"><span class="pre">TRUST_AUTHORITY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='TRUST_AUTHORITY')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type.TRUST_AUTHORITY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Trust Authority provider. This class attribute was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get a provider on a host. This method was added in vSphere API 7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Host identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provider identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Info" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information of the provider.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the host identifier is empty or the provider identifier is
|
||||
empty.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the provider or the host is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
|
||||
requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ReadKeyServersInfo</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List the available providers on a host. This method was added in
|
||||
vSphere API 7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Host identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||||
<li><p><strong>filter_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.FilterSpec" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filter spec.
|
||||
If None, the behavior is equivalent to a
|
||||
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.FilterSpec" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code></a> with all attributes None.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.list" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Summary" title="com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Summary of providers.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the host identifier is empty or the FilterSpec is invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the host is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
|
||||
requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ReadKeyServersInfo</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts.kms_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager.hosts.kms_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts.kms_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -190,7 +190,7 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html">com.vmware.vcenter.crypto_manager.hosts package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#com-vmware-vcenter-crypto-manager-hosts-kms-client-module">com.vmware.vcenter.crypto_manager.hosts.kms_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#module-com.vmware.vcenter.crypto_manager.hosts.kms_client">com.vmware.vcenter.crypto_manager.hosts.kms_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -199,11 +199,940 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-crypto-manager-hosts-client-module">
|
||||
<h2>com.vmware.vcenter.crypto_manager.hosts_client module<a class="headerlink" href="#com-vmware-vcenter-crypto-manager-hosts-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.crypto_manager.hosts_client">
|
||||
<span id="com-vmware-vcenter-crypto-manager-hosts-client-module"></span><h2>com.vmware.vcenter.crypto_manager.hosts_client module<a class="headerlink" href="#module-com.vmware.vcenter.crypto_manager.hosts_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.hosts_client</span></code> module provides classes
|
||||
for managing key providers and cryptographic keys on hosts.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.hosts_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager.hosts_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-crypto-manager-kms-client-module">
|
||||
<h2>com.vmware.vcenter.crypto_manager.kms_client module<a class="headerlink" href="#com-vmware-vcenter-crypto-manager-kms-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.crypto_manager.kms_client">
|
||||
<span id="com-vmware-vcenter-crypto-manager-kms-client-module"></span><h2>com.vmware.vcenter.crypto_manager.kms_client module<a class="headerlink" href="#module-com.vmware.vcenter.crypto_manager.kms_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms_client</span></code> module provides classes
|
||||
for managing key providers and cryptographic keys.</p>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager.kms_client.</span></code><code class="sig-name descname"><span class="pre">Providers</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers</span></code> class provides methods to create, retrieve, update,
|
||||
delete, export and import providers. This class was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Constraints</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tpm_required</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Constraints</span></code> class contains constraints on a provider.
|
||||
This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>tpm_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Determines if a provider is restricted to hosts with TPM 2.0
|
||||
capability. This attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConstraintsSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tpm_required</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ConstraintsSpec</span></code> class contains constraints to be imposed
|
||||
on a provider. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>tpm_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Determines if a provider is restricted to hosts with TPM 2.0
|
||||
capability. This attribute was added in vSphere API 7.0.2.0.
|
||||
If None, the constraint does not apply to the provider.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.CreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">native_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code> class contains attributes that describe the
|
||||
desired configuration for a new provider. This class was added in vSphere
|
||||
API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Provider identifier.</p>
|
||||
<p>A unique string provided by the client.. This attribute was added
|
||||
in vSphere API 7.0.2.0.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p>
|
||||
</p></li>
|
||||
<li><p><strong>constraints</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ConstraintsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The constraints on the provider. This attribute was added in
|
||||
vSphere API 7.0.2.0.
|
||||
If None there are no constraints on the provider.</p></li>
|
||||
<li><p><strong>native_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderCreateSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Native provider create spec. This attribute was added in vSphere
|
||||
API 7.0.2.0.
|
||||
This attribute is required when creating a
|
||||
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a> provider.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportResult">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ExportResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportResult" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ExportResult</span></code> class contains result of
|
||||
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.export" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.export"><code class="xref py py-func docutils literal notranslate"><span class="pre">Providers.export()</span></code></a> operation. This class was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ExportType</span></code></a>) – Type of provider export result. This attribute was added in vSphere
|
||||
API 7.0.2.0.</p></li>
|
||||
<li><p><strong>location</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Location" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Location</span></code></a>) – Location of the exported configuration. This attribute was added in
|
||||
vSphere API 7.0.2.0.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType.LOCATION" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType.LOCATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ExportType.LOCATION</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ExportSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ExportSpec</span></code> class contains attributes that are needed to
|
||||
export a provider. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provider identifier. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
|
||||
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Password used to encrypt the exported configuration. This attribute
|
||||
was added in vSphere API 7.0.2.0.
|
||||
If None or empty, the configuration will not be encrypted.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ExportType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ExportType</span></code> class identifies the type of result that is
|
||||
returned when a provider is exported. This enumeration was added in vSphere
|
||||
API 7.0.2.0.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ExportType</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType.LOCATION">
|
||||
<code class="sig-name descname"><span class="pre">LOCATION</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ExportType(string='LOCATION')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType.LOCATION" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Result returned as a URL from which the provider configuration can be
|
||||
downloaded. This class attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">providers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing providers. This class was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>providers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provider identifiers. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.
|
||||
If None or empty, the result will not be filtered by provider
|
||||
identifier.</p></li>
|
||||
<li><p><strong>health</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provider health status. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
If None or empty, the result will not be filtered by provider
|
||||
health status.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Health</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Health</span></code> class describes the health status of a provider.
|
||||
This enumeration was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.ERROR">
|
||||
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>There is a critical issue that requires attention. This class attribute was
|
||||
added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.NONE">
|
||||
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>No health status is available. This class attribute was added in vSphere
|
||||
API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.OK">
|
||||
<code class="sig-name descname"><span class="pre">OK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='OK')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.OK" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Operating normally. This class attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.WARNING">
|
||||
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.WARNING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Operating normally, but there is an issue that requires attention. This
|
||||
class attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportResult">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ImportResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">native_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportResult" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ImportResult</span></code> class contains result of the
|
||||
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.import_provider" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.import_provider"><code class="xref py py-func docutils literal notranslate"><span class="pre">Providers.import_provider()</span></code></a> operation. This class was added in
|
||||
vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provider identifier. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a>) – Provider type. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
||||
<li><p><strong>native_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderInfo</span></code></a>) – Native provider information. This attribute was added in vSphere
|
||||
API 7.0.2.0.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>.</p></li>
|
||||
<li><p><strong>export_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the provider was exported. This attribute was added in
|
||||
vSphere API 7.0.2.0.</p></li>
|
||||
<li><p><strong>constraints</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Constraints</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The constraints on the provider. This attribute was added in
|
||||
vSphere API 7.0.2.0.
|
||||
If None, there are no constraints on the provider.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ImportSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dry_run</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ImportSpec</span></code> class contains attributes that are needed to
|
||||
import a provider. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Configuration to import. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
Currently this is required. Other import methods may be supported
|
||||
in the future.</p></li>
|
||||
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Password to decrypt the configuration to import. This attribute was
|
||||
added in vSphere API 7.0.2.0.
|
||||
If None or empty, configuration to import must be unencrypted.</p></li>
|
||||
<li><p><strong>constraints</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ConstraintsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Constraints to impose on the imported provider. This attribute was
|
||||
added in vSphere API 7.0.2.0.
|
||||
If None, the imported provider constraints will match the exported
|
||||
provider constraints.</p></li>
|
||||
<li><p><strong>dry_run</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Whether to perform a trial import without actuallly creating a
|
||||
provider. This attribute was added in vSphere API 7.0.2.0.
|
||||
If None, a new provider will be created.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Info">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">native_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Info</span></code> class contains attributes that describe the details
|
||||
of a provider. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a>) – Health status of the provider. This attribute was added in vSphere
|
||||
API 7.0.2.0.</p></li>
|
||||
<li><p><strong>details</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Details regarding the health status of the provider.</p>
|
||||
<p>When the provider <code class="docutils literal notranslate"><span class="pre">Providers.Health</span></code> is not
|
||||
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.NONE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.NONE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Health.NONE</span></code></a> or <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.OK" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.OK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Health.OK</span></code></a>, this
|
||||
attribute will provide actionable descriptions of the issues.. This
|
||||
attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</p></li>
|
||||
<li><p><strong>constraints</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Constraints</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The constraints on the provider. This attribute was added in
|
||||
vSphere API 7.0.2.0.
|
||||
If None, there are no constraints on the provider.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a>) – Provider type. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
||||
<li><p><strong>native_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderInfo</span></code></a>) – Native provider information. This attribute was added in vSphere
|
||||
API 7.0.2.0.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Location">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Location</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Location" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Location</span></code> class contains the location as well as a token
|
||||
required (as a header in the HTTP GET request) to download the
|
||||
configuration. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provider configuration download URL. This attribute was added in
|
||||
vSphere API 7.0.2.0.</p></li>
|
||||
<li><p><strong>download_token</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Token" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Token"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Token</span></code></a>) – Information about the token required in the HTTP GET request to
|
||||
download the provider configuration. This attribute was added in
|
||||
vSphere API 7.0.2.0.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderCreateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NativeProviderCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_derivation_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderCreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.NativeProviderCreateSpec</span></code> class contains attributes that
|
||||
describe the desired configuration for a <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>
|
||||
provider. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Key identifier for the provider.</p>
|
||||
<p>The key identifier is required to be a 128-bit UUID represented as
|
||||
a hexadecimal string in “12345678-abcd-1234-cdef-123456789abc”
|
||||
format.. This attribute was added in vSphere API 7.0.2.0.
|
||||
If None, the key identifier will be generated automatically.</p>
|
||||
</p></li>
|
||||
<li><p><strong>key_derivation_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Key used to derive data encryption keys. Base64 encoded. This
|
||||
attribute was added in vSphere API 7.0.2.0.
|
||||
If None, the key derivation key will be generated automatically.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NativeProviderInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.NativeProviderInfo</span></code> class contains attributes that
|
||||
describe details of a native provider. This class was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Key identifier for the provider. This attribute was added in
|
||||
vSphere API 7.0.2.0.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderUpdateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NativeProviderUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderUpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.NativeProviderUpdateSpec</span></code> class contains attributes that
|
||||
describe the desired configuration for <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>
|
||||
provider. Exporting a <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a> provider to create a
|
||||
new back-up is suggested after any update. This class was added in vSphere
|
||||
API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Key identifier for the provider.</p>
|
||||
<p>The key identifier is required to be a 128-bit UUID represented as
|
||||
a hexadecimal string in “12345678-abcd-1234-cdef-123456789abc”
|
||||
format.. This attribute was added in vSphere API 7.0.2.0.
|
||||
If None, the key identifier will remain unchanged.</p>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.RESOURCE_TYPE">
|
||||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.crypto_manager.kms.provider'</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for a provider. This class attribute was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Summary">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Summary</span></code> class contains attributes that describe a
|
||||
provider. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provider identifier. This attribute was added in vSphere API
|
||||
7.0.2.0.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a>) – Provider type. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
||||
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a>) – Health status of the provider. This attribute was added in vSphere
|
||||
API 7.0.2.0.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Token">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Token</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expiry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Token" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Token</span></code> class contains information about the token required
|
||||
to be passed in the HTTP header in the HTTP GET request to download the
|
||||
provider configuration. This class was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>A one-time, short-lived token required in “Authorization” field of
|
||||
the HTTP header of the request to the url.</p>
|
||||
<p>After the token expires, any attempt to download the configuration
|
||||
with said token will fail.. This attribute was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
</p></li>
|
||||
<li><p><strong>expiry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Expiry time of the token. This attribute was added in vSphere API
|
||||
7.0.2.0.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Type</span></code> class contains the types of providers. This
|
||||
enumeration was added in vSphere API 7.0.2.0.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. The class contains class attributes which represent the
|
||||
values in the current version of the enumerated type. Newer versions of
|
||||
the enumerated type may contain new values. To use new values of the
|
||||
enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE">
|
||||
<code class="sig-name descname"><span class="pre">NATIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='NATIVE')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Native provider. This class attribute was added in vSphere API 7.0.2.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.UpdateSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">native_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code> class contains attributes that describe the
|
||||
new configuration for an existing provider. This class was added in vSphere
|
||||
API 7.0.2.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>native_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderUpdateSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>New Configuration for <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a> provider.</p>
|
||||
<p>. This attribute was added in vSphere API 7.0.2.0.
|
||||
If None, provider configuration will remain unchanged.</p>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a new provider. This method was added in vSphere API 7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.CreateSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code></a>) – Provider information.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||||
if a provider with the same identifier already exists.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the spec is invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
if creating a provider of the type is not supported.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ManageKeyServers</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove a provider. This method was added in vSphere API 7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the provider.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the provider identifier is empty.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the provider is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
if the provider’s type does not allow deletion.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ManageKeyServers</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.export">
|
||||
<code class="sig-name descname"><span class="pre">export</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.export" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Export provider configuration. This method was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ExportSpec</span></code></a>) – ExportSpec needed to export a provider.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportResult" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ExportResult</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>ExportResult.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the provider identifier is empty.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the provider with the identifier is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
if the provider’s type does not allow export.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ManageKeyServers</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return information about a provider. This method was added in vSphere
|
||||
API 7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the provider.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Info" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information of the provider.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the provider identifier is empty.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the provider is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ReadKeyServersInfo</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.import_provider">
|
||||
<code class="sig-name descname"><span class="pre">import_provider</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.import_provider" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Import provider configuration. This method was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ImportSpec</span></code></a>) – ImportSpec needed to import a provider.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportResult" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ImportResult</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>importResult ImportResult.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||||
if a provider with the same identifier already exists.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the config or the password is invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ManageKeyServers</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return a list of providers.</p>
|
||||
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>filter_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filter for the providers list.
|
||||
If None, the behavior is equivalent to a
|
||||
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code></a> with all attributes None.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.list" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Summary" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Summary of providers.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the spec is invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ReadKeyServersInfo</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.update">
|
||||
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update an existing provider. This method was added in vSphere API
|
||||
7.0.2.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the provider.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.UpdateSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code></a>) – Provider information.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if there is a generic error.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the spec is invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the provider is not found.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the caller is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
if the provider’s type does not allow updates.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">Cryptographer.ManageKeyServers</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.crypto_manager.kms_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager.kms_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
@ -95,13 +95,13 @@
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-appliance-client-module">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-cis-client-module">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-content-client-module">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-oauth2-client-module">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vapi-client-module">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vcenter-client-module">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-vstats-client-module">com.vmware.vstats_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -192,13 +192,13 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html">com.vmware.vcenter.deployment.install.initial_config package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#com-vmware-vcenter-deployment-install-initial-config-remote-psc-client-module">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#module-com.vmware.vcenter.deployment.install.initial_config.remote_psc_client">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#com-vmware-vcenter-deployment-install-psc-client-module">com.vmware.vcenter.deployment.install.psc_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#module-com.vmware.vcenter.deployment.install.psc_client">com.vmware.vcenter.deployment.install.psc_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -207,11 +207,192 @@
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-deployment-install-client-module">
|
||||
<h2>com.vmware.vcenter.deployment.install_client module<a class="headerlink" href="#com-vmware-vcenter-deployment-install-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.deployment.install_client">
|
||||
<span id="com-vmware-vcenter-deployment-install-client-module"></span><h2>com.vmware.vcenter.deployment.install_client module<a class="headerlink" href="#module-com.vmware.vcenter.deployment.install_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.deployment.install_client.RemotePsc">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment.install_client.</span></code><code class="sig-name descname"><span class="pre">RemotePsc</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install_client.RemotePsc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">RemotePsc</span></code> class provides methods to check if the deployed vCenter
|
||||
Server can register with the remote PSC. This class was added in vSphere
|
||||
API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.deployment.install_client.RemotePsc.check">
|
||||
<code class="sig-name descname"><span class="pre">check</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install_client.RemotePsc.check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks whether the remote PSC is reachable and the deployed vCenter
|
||||
Server can be registered with the remote PSC. This method was added in
|
||||
vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.RemotePscSpec" title="com.vmware.vcenter.deployment_client.RemotePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a>) – Information to connect to the remote PSC.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.CheckInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the success or failure of the checks that were
|
||||
performed.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if external PSC credentials are not valid when configuring a
|
||||
VCSA_EXTERNAL appliance.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if passed arguments are invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if the appliance is not in INITIALIZED state.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.deployment.install_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment.install_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="com-vmware-vcenter-deployment-migrate-client-module">
|
||||
<h2>com.vmware.vcenter.deployment.migrate_client module<a class="headerlink" href="#com-vmware-vcenter-deployment-migrate-client-module" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="module-com.vmware.vcenter.deployment.migrate_client">
|
||||
<span id="com-vmware-vcenter-deployment-migrate-client-module"></span><h2>com.vmware.vcenter.deployment.migrate_client module<a class="headerlink" href="#module-com.vmware.vcenter.deployment.migrate_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.deployment.migrate_client.ActiveDirectory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment.migrate_client.</span></code><code class="sig-name descname"><span class="pre">ActiveDirectory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.migrate_client.ActiveDirectory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ActiveDirectory</span></code> class provides methods to check if the migrated
|
||||
vCenter Server appliance can join to the given domain using the provided
|
||||
credentials. This class was added in vSphere API 7.0.0.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.deployment.migrate_client.ActiveDirectory.CheckSpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CheckSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dns_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.migrate_client.ActiveDirectory.CheckSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ActiveDirectory.CheckSpec</span></code> class contains information used to join
|
||||
the migrated vCenter Server appliance to the Active Directory. This class
|
||||
was added in vSphere API 7.0.0.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>dns_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IP addresses of the DNS servers of the Active Directory server.
|
||||
This attribute was added in vSphere API 7.0.0.0.</p></li>
|
||||
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The domain name of the Active Directory server to which the
|
||||
migrated vCenter Server appliance should be joined. This attribute
|
||||
was added in vSphere API 7.0.0.0.</p></li>
|
||||
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Active Directory user that has permission to join the Active
|
||||
Directory after the vCenter Server is migrated to appliance. This
|
||||
attribute was added in vSphere API 7.0.0.0.</p></li>
|
||||
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Active Directory user password that has permission to join the
|
||||
Active Directory after the vCenter Server is migrated to appliance.
|
||||
This attribute was added in vSphere API 7.0.0.0.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="com.vmware.vcenter.deployment.migrate_client.ActiveDirectory.check">
|
||||
<code class="sig-name descname"><span class="pre">check</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.migrate_client.ActiveDirectory.check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks whether the provided Active Directory user has permission to
|
||||
join the migrated vCenter Server appliance to the domain. This method
|
||||
was added in vSphere API 7.0.0.0.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment.migrate_client.ActiveDirectory.CheckSpec" title="com.vmware.vcenter.deployment.migrate_client.ActiveDirectory.CheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ActiveDirectory.CheckSpec</span></code></a>) – Information to connect to Active Directory.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.CheckInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the success or failure of the checks that were
|
||||
performed.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if passed arguments are invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if the appliance is not in INITIALIZED state.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment.migrate_client.</span></code><code class="sig-name descname"><span class="pre">ActiveDirectorySpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ActiveDirectorySpec</span></code> class contains information used to join the
|
||||
migrated vCenter Server appliance to the Active Directory. This class was
|
||||
added in vSphere API 7.0.0.0.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The domain name of the Active Directory server to which the
|
||||
migrated vCenter Server appliance should be joined. This attribute
|
||||
was added in vSphere API 7.0.0.0.</p></li>
|
||||
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Active Directory user that has permission to join the Active
|
||||
Directory after the vCenter Server is migrated to appliance. This
|
||||
attribute was added in vSphere API 7.0.0.0.</p></li>
|
||||
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Active Directory user password that has permission to join the
|
||||
Active Directory after the vCenter Server is migrated to appliance.
|
||||
This attribute was added in vSphere API 7.0.0.0.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="com.vmware.vcenter.deployment.migrate_client.StubFactory">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment.migrate_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.migrate_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user