Blame - docs/dmi_0_10_1.html - grpc-robot

background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAALEwAACxMBAJqcGAAAAY5JREFUSImt1LtrFGEUBfCfURsFHwEr29UNkS3MFklrQK0EIYUk/5IQ0FSmCCKW1mpAommToCKoK+lsLUKeSFbXFLuT3B13Hjt64INvOPeec+fOnUs2mpjHBrbRwQE+YQFTObm5qGMZf0qct7gxjPgM9kqKJ+cAs2XFf4fEX3iOe7iKsxjFHTxFO8R2ikzqqcq/oVFQUANfUm8ynhUce97qVVoGo/gaclcGBTVDQDuvigw09Lfrr+maD+TSkOIJngWNx2lyI5C3KxrcDRof0+R2IC9XNLgSNPbTZDKa7YricFr/v3EqIUZ0xxPO4FxFg0vhnoz7scFmICcqGjTDvRWJEayG57mKBg/C/U2anHDSu5+oDSlex6GTlTE2KOhVMPmACyXFL+qOZZL7Xf/3OMY17KZMrheI13px6e26nmVyX3eDxnYt4lav0qTiaTzp8VkrPNdkNyOpkyM4lEkNL0uK/CjgXw8ySHATD7GGLd0/fgfv8QiTOI93BSb/jCKT/4Isk1ZOTiWTF0H8M8aPANvFyARlADGFAAAAAElFTkSuQmCC);

119

background-image: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4IiBoZWlnaHQ9IjgiIHZpZXdCb3g9IjAgMCA4IDgiPgogIDxwYXRoIGQ9Ik0zLjUgMGMtMS45MyAwLTMuNSAxLjU3LTMuNSAzLjVzMS41NyAzLjUgMy41IDMuNWMuNTkgMCAxLjE3LS4xNCAxLjY2LS40MWExIDEgMCAwIDAgLjEzLjEzbDEgMWExLjAyIDEuMDIgMCAxIDAgMS40NC0xLjQ0bC0xLTFhMSAxIDAgMCAwLS4xNi0uMTNjLjI3LS40OS40NC0xLjA2LjQ0LTEuNjYgMC0xLjkzLTEuNTctMy41LTMuNS0zLjV6bTAgMWMxLjM5IDAgMi41IDEuMTEgMi41IDIuNSAwIC42Ni0uMjQgMS4yNy0uNjYgMS43Mi0uMDEuMDEtLjAyLjAyLS4wMy4wM2ExIDEgMCAwIDAtLjEzLjEzYy0uNDQuNC0xLjA0LjYzLTEuNjkuNjMtMS4zOSAwLTIuNS0xLjExLTIuNS0yLjVzMS4xMS0yLjUgMi41LTIuNXoiCiAgLz4KPC9zdmc+), none;

120

background-size: 24px 24px;

121

}

122

#open-search:hover {

123

background-color: #ccc;

}

fieldset {

background: white;

border: 2px solid #ccc;

border-radius: 4px;

padding: 6px 8px;

}

fieldset fieldset {

border: 1px solid #ccc;

margin: 4px 0;

}

#search-title {

font-size: 1.1em;

font-weight: bold;

letter-spacing: 1px;

}

#search-string {

box-sizing: border-box;

width: 100%;

}

#hide-unmatched {

margin: 0.5em 0 0 1em;

}

#search-buttons {

float: right;

}

.highlight {

background: yellow;

}

.no-match {

color: gray !important;

155

}

156

tr.no-match.hide-unmatched {

display: none;

}

</style>

/* Pygments 'default' style sheet. Generated with Pygments 2.1.3 using:

162

pygmentize -S default -f html -a .code > src/robot/htmldata/libdoc/pygments.css

163

*/

164

.code .hll { background-color: #ffffcc }

165

.code { background: #f8f8f8; }

166

.code .c { color: #408080; font-style: italic } /* Comment */

167

.code .err { border: 1px solid #FF0000 } /* Error */

168

.code .k { color: #008000; font-weight: bold } /* Keyword */

169

.code .o { color: #666666 } /* Operator */

170

.code .ch { color: #408080; font-style: italic } /* Comment.Hashbang */

171

.code .cm { color: #408080; font-style: italic } /* Comment.Multiline */

172

.code .cp { color: #BC7A00 } /* Comment.Preproc */

173

.code .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */

174

.code .c1 { color: #408080; font-style: italic } /* Comment.Single */

175

.code .cs { color: #408080; font-style: italic } /* Comment.Special */

176

.code .gd { color: #A00000 } /* Generic.Deleted */

177

.code .ge { font-style: italic } /* Generic.Emph */

178

.code .gr { color: #FF0000 } /* Generic.Error */

179

.code .gh { color: #000080; font-weight: bold } /* Generic.Heading */

180

.code .gi { color: #00A000 } /* Generic.Inserted */

181

.code .go { color: #888888 } /* Generic.Output */

182

.code .gp { color: #000080; font-weight: bold } /* Generic.Prompt */

183

.code .gs { font-weight: bold } /* Generic.Strong */

184

.code .gu { color: #800080; font-weight: bold } /* Generic.Subheading */

185

.code .gt { color: #0044DD } /* Generic.Traceback */

186

.code .kc { color: #008000; font-weight: bold } /* Keyword.Constant */

187

.code .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */

188

.code .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */

189

.code .kp { color: #008000 } /* Keyword.Pseudo */

190

.code .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */

191

.code .kt { color: #B00040 } /* Keyword.Type */

192

.code .m { color: #666666 } /* Literal.Number */

193

.code .s { color: #BA2121 } /* Literal.String */

194

.code .na { color: #7D9029 } /* Name.Attribute */

195

.code .nb { color: #008000 } /* Name.Builtin */

196

.code .nc { color: #0000FF; font-weight: bold } /* Name.Class */

197

.code .no { color: #880000 } /* Name.Constant */

198

.code .nd { color: #AA22FF } /* Name.Decorator */

199

.code .ni { color: #999999; font-weight: bold } /* Name.Entity */

200

.code .ne { color: #D2413A; font-weight: bold } /* Name.Exception */

201

.code .nf { color: #0000FF } /* Name.Function */

202

.code .nl { color: #A0A000 } /* Name.Label */

203

.code .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */

204

.code .nt { color: #008000; font-weight: bold } /* Name.Tag */

205

.code .nv { color: #19177C } /* Name.Variable */

206

.code .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */

207

.code .w { color: #bbbbbb } /* Text.Whitespace */

208

.code .mb { color: #666666 } /* Literal.Number.Bin */

209

.code .mf { color: #666666 } /* Literal.Number.Float */

210

.code .mh { color: #666666 } /* Literal.Number.Hex */

211

.code .mi { color: #666666 } /* Literal.Number.Integer */

212

.code .mo { color: #666666 } /* Literal.Number.Oct */

213

.code .sb { color: #BA2121 } /* Literal.String.Backtick */

214

.code .sc { color: #BA2121 } /* Literal.String.Char */

215

.code .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */

216

.code .s2 { color: #BA2121 } /* Literal.String.Double */

217

.code .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */

218

.code .sh { color: #BA2121 } /* Literal.String.Heredoc */

219

.code .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */

220

.code .sx { color: #008000 } /* Literal.String.Other */

221

.code .sr { color: #BB6688 } /* Literal.String.Regex */

222

.code .s1 { color: #BA2121 } /* Literal.String.Single */

223

.code .ss { color: #19177C } /* Literal.String.Symbol */

224

.code .bp { color: #008000 } /* Name.Builtin.Pseudo */

225

.code .vc { color: #19177C } /* Name.Variable.Class */

226

.code .vg { color: #19177C } /* Name.Variable.Global */

227

.code .vi { color: #19177C } /* Name.Variable.Instance */

228

.code .il { color: #666666 } /* Literal.Number.Integer.Long */

</style>

body {

margin: 0;

padding: 0;

font-size: 8pt;

}

a {

text-decoration: none;

238

}

239

#search, #open-search {

display: none;

}

</style>

#javascript-disabled {

245

width: 600px;

246

margin: 100px auto 0 auto;

247

padding: 20px;

248

color: black;

249

border: 1px solid #ccc;

250

background: #eee;

251

}

252

#javascript-disabled h1 {

width: 100%;

float: none;

}

#javascript-disabled ul {

257

font-size: 1.2em;

258

}

259

#javascript-disabled li {

260

margin: 0.5em 0;

261

}

262

#javascript-disabled b {

font-style: italic;

}

</style>

.doc > * {

margin: 0.7em 1em 0.1em 1em;

269

padding: 0;

270

}

271

.doc > p, .doc > h1, .doc > h2, .doc > h3, .doc > h4 {

272

margin: 0.7em 0 0.1em 0;

273

}

274

.doc > *:first-child {

margin-top: 0.1em;

}

.doc table {

border: 1px solid #ccc;

279

background: transparent;

280

border-collapse: collapse;

empty-cells: show;

font-size: 0.9em;

}

.doc table th, .doc table td {

285

border: 1px solid #ccc;

286

background: transparent;

287

padding: 0.1em 0.3em;

height: 1.2em;

}

.doc table th {

text-align: center;

letter-spacing: 0.1em;

}

.doc pre {

font-size: 1.1em;

letter-spacing: 0.05em;

background: #f4f4f4;

}

.doc code {

padding: 0 0.2em;

letter-spacing: 0.05em;

background: #eee;

}

.doc li {

list-style-position: inside;

306

list-style-type: square;

307

}

308

.doc img {

309

border: 1px solid #ccc;

}

.doc hr {

background: #ccc;

height: 1px;

border: 0;

}

</style>

Martin Cosyns

2021-09-27 16:24:30 +0000

[diff] [blame]

318

window.util = function () {

319

function map(elems, func) {

320

var ret = [];

321

for (var i = 0, len = elems.length; i < len; i++) {

322

ret[i] = func(elems[i]);

}

return ret;

}

function filter(elems, predicate) {

327

var ret = [];

328

for (var i = 0, len = elems.length; i < len; i++) {

329

if (predicate(elems[i]))

ret.push(elems[i]);

}

return ret;

}

function all(elems) {

335

for (var i = 0, len = elems.length; i < len; i++) {

if (!elems[i])

return false;

}

return true;

}

function any(elems) {

342

for (var i = 0, len = elems.length; i < len; i++) {

if (elems[i])

return elems[i];

}

return false;

}

function contains(elems, e) {

349

for (var i = 0, len = elems.length; i < len; i++) {

if (elems[i] == e)

return true;

}

return false;

}

function last(items) {

356

return items[items.length-1];

357

}

358

function unescape(string) {

359

return string.replace(/</g, '<').replace(/>/g, '>').replace(/&/g, '&');

360

}

361

function escape(string) {

362

return string.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>');

363

}

364

function normalize(string) {

365

return string.toLowerCase().replace(/ /g, '').replace(/_/g, '');

366

}

367

function regexpEscape(string) {

368

return string.replace(/[-[\]{}()+?*.,\\^$|#]/g, "\\$&");

369

}

370

function Matcher(pattern) {

371

pattern = regexpEscape(normalize(pattern));

372

var rePattern = '^' + pattern.replace(/\\\?/g, '.').replace(/\\\*/g, '[\\s\\S]*') + '$';

373

var regexp = new RegExp(rePattern);

374

function matches(string) {

375

return regexp.test(normalize(string));

}

return {

matches: matches,

matchesAny: function (strings) {

380

for (var i = 0, len = strings.length; i < len; i++)

381

if (matches(strings[i]))

return true;

return false;

}

};

}

function formatParentName(item) {

388

var parentName = item.fullName.slice(0, item.fullName.length - item.name.length);

389

return parentName.replace(/\./g, ' . ');

390

}

391

function timeFromDate(date) {

392

if (!date)

393

return 'N/A';

394

return formatTime(date.getHours(), date.getMinutes(),

395

date.getSeconds(), date.getMilliseconds());

396

}

397

function dateFromDate(date) {

398

if (!date)

399

return 'N/A';

400

return padTo(date.getFullYear(), 4) +

401

padTo(date.getMonth() + 1, 2) +

402

padTo(date.getDate(), 2);

403

}

404

function dateTimeFromDate(date) {

405

if (!date)

406

return 'N/A';

407

return dateFromDate(date) + ' ' + timeFromDate(date);

408

}

409

function formatTime(hours, minutes, seconds, milliseconds) {

410

return padTo(hours, 2) + ':' +

411

padTo(minutes, 2) + ':' +

412

padTo(seconds, 2) + '.' +

413

padTo(milliseconds, 3);

414

}

415

function formatElapsed(elapsed) {

416

var millis = elapsed;

417

var hours = Math.floor(millis / (60 * 60 * 1000));

418

millis -= hours * 60 * 60 * 1000;

419

var minutes = Math.floor(millis / (60 * 1000));

420

millis -= minutes * 60 * 1000;

421

var seconds = Math.floor(millis / 1000);

422

millis -= seconds * 1000;

423

return formatTime(hours, minutes, seconds, millis);

424

}

425

function padTo(number, len) {

426

var numString = number + "";

427

while (numString.length < len) numString = "0" + numString;

428

return numString;

429

}

430

function timestamp(millis) {

431

// used also by tools that do not set window.output.baseMillis

432

var base = window.output ? window.output.baseMillis : 0;

433

return new Date(base + millis);

434

}

435

function createGeneratedString(timestamp) {

436

var date = new Date(timestamp);

437

var dt = dateTimeFromDate(date).slice(0, 17); // drop millis

438

var offset = date.getTimezoneOffset();

439

var sign = offset > 0 ? '-' : '+';

440

var hh = Math.floor(Math.abs(offset) / 60);

441

var mm = Math.abs(offset) % 60;

442

return dt + ' UTC' + sign + padTo(hh, 2) + ':' + padTo(mm, 2);

443

}

444

function createGeneratedAgoString(timestamp) {

445

function timeString(time, shortUnit) {

446

var unit = {y: 'year', d: 'day', h: 'hour', m: 'minute',

447

s: 'second'}[shortUnit];

448

var end = time == 1 ? ' ' : 's ';

449

return time + ' ' + unit + end;

450

}

451

function compensateLeapYears(days, years) {

452

// Not a perfect algorithm but ought to be enough

453

return days - Math.floor(years / 4);

454

}

455

var generated = Math.round(timestamp / 1000);

456

var current = Math.round(new Date().getTime() / 1000);

457

var elapsed = current - generated;

var prefix = '';

if (elapsed < 0) {

prefix = '- ';

elapsed = Math.abs(elapsed);

462

}

463

var secs = elapsed % 60;

464

var mins = Math.floor(elapsed / 60) % 60;

465

var hours = Math.floor(elapsed / (60*60)) % 24;

466

var days = Math.floor(elapsed / (60*60*24)) % 365;

467

var years = Math.floor(elapsed / (60*60*24*365));

468

if (years) {

469

days = compensateLeapYears(days, years);

470

return prefix + timeString(years, 'y') + timeString(days, 'd');

471

} else if (days) {

472

return prefix + timeString(days, 'd') + timeString(hours, 'h');

473

} else if (hours) {

474

return prefix + timeString(hours, 'h') + timeString(mins, 'm');

475

} else if (mins) {

476

return prefix + timeString(mins, 'm') + timeString(secs, 's');

477

} else {

478

return prefix + timeString(secs, 's');

479

}

480

}

481

function parseQueryString(query) {

var result = {};

if (!query)

return result;

var params = query.split('&');

486

var parts;

487

function decode(item) {

488

return decodeURIComponent(item.replace('+', ' '));

489

}

490

for (var i = 0, len = params.length; i < len; i++) {

491

parts = params[i].split('=');

492

result[decode(parts.shift())] = decode(parts.join('='));

}

return result;

}

return {

map: map,

filter: filter,

all: all,

any: any,

contains: contains,

last: last,

escape: escape,

unescape: unescape,

normalize: normalize,

506

regexpEscape: regexpEscape,

507

Matcher: Matcher,

508

formatParentName: formatParentName,

509

timeFromDate: timeFromDate,

510

dateFromDate: dateFromDate,

511

dateTimeFromDate: dateTimeFromDate,

512

formatElapsed: formatElapsed,

513

timestamp: timestamp,

514

createGeneratedString: createGeneratedString,

515

createGeneratedAgoString: createGeneratedAgoString,

516

parseQueryString: parseQueryString

};

}();

</script>

Andrea Campanella

2022-02-07 13:05:57 +0000

[diff] [blame]

521

/*! jQuery v3.3.1 | (c) JS Foundation and other contributors | jquery.org/license */

522

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

</script>

/*

* jQuery Templates Plugin 1.0.0pre

527

* http://github.com/jquery/jquery-tmpl

528

* Requires jQuery 1.4.2

529

*

530

* Copyright Software Freedom Conservancy, Inc.

531

* Dual licensed under the MIT or GPL Version 2 licenses.

532

* http://jquery.org/license

*/

</script>

/*

* jQuery Highlight plugin

539

*

540

* Based on highlight v3 by Johann Burkard

541

* http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html

*

*

* Licensed under MIT license.

546

*/

547

jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}

548

</script>

549

Andrea Campanella

8147751

2022-02-07 13:05:57 +0000

[diff] [blame]

550

libdoc = {"all_tags":[],"contains_tags":false,"doc":"<p>This library is intended to supported different Protocol Buffer definitions. Precondition is that python files generated from Protocol Buffer files are available in a pip package which must be installed before the library is used.\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Supported device\x3c/td>\n<td>Pip package\x3c/td>\n<td>Pip package version\x3c/td>\n<td>Library Name\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.9.1\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.9.2\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.9.3\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.9.4\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.9.5\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.9.6\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.9.8\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.9.9\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.10.1\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.10.2\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>0.12.0\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n<tr>\n<td>dmi\x3c/td>\n<td>device-management-interface\x3c/td>\n<td>1.0.0\x3c/td>\n<td>grpc_robot.Dmi\x3c/td>\n\x3c/tr>\n\x3c/table>","generated":"2022-02-07 12:57:03","inits":[],"keywords":[{"args":[],"doc":"<p>Closes the connection to the gRPC host.\x3c/p>","matched":true,"name":"Connection Close","shortdoc":"","tags":[]},{"args":["host","port","**kwargs"],"doc":"<p>Opens a connection to the gRPC host.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>host: <string>|<IP address>; Name or IP address of the gRPC host.\x3c/li>\n<li>port: <number>; TCP port of the gRPC host.\x3c/li>\n\x3c/ul>\n<p><b>Named Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>timeout: <number>; Timeout in seconds for a gRPC response. Default: 30 s\x3c/li>\n\x3c/ul>","matched":true,"name":"Connection Open","shortdoc":"","tags":[]},{"args":[],"doc":"<p>Retrieves the connection parameters for the gRPC channel.\x3c/p>\n<p><b>Return\x3c/b>: A dictionary with the keys:\x3c/p>\n<ul>\n<li>timeout\x3c/li>\n\x3c/ul>","matched":true,"name":"Connection Parameters Get","shortdoc":"","tags":[]},{"args":["**kwargs"],"doc":"<p>Sets the gRPC channel connection parameters.\x3c/p>\n<p><b>Named Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>timeout: <number>; Timeout in seconds for a gRPC response.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>: Same dictionary as the keyword <i>Connection Parameter Get\x3c/i> with the values before they got changed.\x3c/p>","matched":true,"name":"Connection Parameters Set","shortdoc":"","tags":[]},{"args":[],"doc":"<p>Retrieve the version of the currently used python module <i>device-management-interface\x3c/i>.\x3c/p>\n<p><b>Return\x3c/b>: version string consisting of three dot-separated numbers (x.y.z)\x3c/p>","matched":true,"name":"Dmi Version Get","shortdoc":"","tags":[]},{"args":[],"doc":"<p>Returns the list of keyword names\x3c/p>","matched":true,"name":"Get Keyword Names","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>ListEvents\x3c/i> from <i>NativeEventsManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: HardwareID\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>: <b>Note\x3c/b>: Bold dictionary keys are cases of an ONEOF type that is not transmitted in gRPC.\x3c/p>\n<pre>\n{ # type: ListEventsResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'events': { # type: EventsCfg\n 'items': [ # list of:\n { # type: EventCfg\n 'event_id': < 0 - EVENT_NAME_UNDEFINED |\n 100 - EVENT_TRANSCEIVER_PLUG_OUT |\n 101 - EVENT_TRANSCEIVER_PLUG_IN |\n 102 - EVENT_TRANSCEIVER_VOLTAGE_ABOVE_THRESHOLD |\n 103 - EVENT_TRANSCEIVER_VOLTAGE_BELOW_THRESHOLD |\n 104 - EVENT_TRANSCEIVER_TEMPERATURE_ABOVE_THRESHOLD |\n 105 - EVENT_TRANSCEIVER_TEMPERATURE_BELOW_THRESHOLD |\n 106 - EVENT_TRANSCEIVER_CURRENT_ABOVE_THRESHOLD |\n 107 - EVENT_TRANSCEIVER_CURRENT_BELOW_THRESHOLD |\n 108 - EVENT_TRANSCEIVER_RX_POWER_ABOVE_THRESHOLD |\n 109 - EVENT_TRANSCEIVER_RX_POWER_BELOW_THRESHOLD |\n 110 - EVENT_TRANSCEIVER_TX_POWER_ABOVE_THRESHOLD |\n 111 - EVENT_TRANSCEIVER_TX_POWER_BELOW_THRESHOLD |\n 112 - EVENT_TRANSCEIVER_FAILURE |\n 113 - EVENT_TRANSCEIVER_VOLTAGE_ABOVE_THRESHOLD_RECOVERED |\n 114 - EVENT_TRANSCEIVER_VOLTAGE_BELOW_THRESHOLD_RECOVERED |\n 115 - EVENT_TRANSCEIVER_TEMPERATURE_ABOVE_THRESHOLD_RECOVERED |\n 116 - EVENT_TRANSCEIVER_TEMPERATURE_BELOW_THRESHOLD_RECOVERED |\n 117 - EVENT_TRANSCEIVER_CURRENT_ABOVE_THRESHOLD_RECOVERED |\n 118 - EVENT_TRANSCEIVER_CURRENT_BELOW_THRESHOLD_RECOVERED |\n 119 - EVENT_TRANSCEIVER_RX_POWER_ABOVE_THRESHOLD_RECOVERED |\n 120 - EVENT_TRANSCEIVER_RX_POWER_BELOW_THRESHOLD_RECOVERED |\n 121 - EVENT_TRANSCEIVER_TX_POWER_ABOVE_THRESHOLD_RECOVERED |\n 122 - EVENT_TRANSCEIVER_TX_POWER_BELOW_THRESHOLD_RECOVERED |\n 123 - EVENT_TRANSCEIVER_FAILURE_RECOVERED |\n 200 - EVENT_PSU_PLUG_OUT |\n 201 - EVENT_PSU_PLUG_IN |\n 202 - EVENT_PSU_FAILURE |\n 203 - EVENT_PSU_FAILURE_RECOVERED |\n 300 - EVENT_FAN_FAILURE |\n 301 - EVENT_FAN_PLUG_OUT |\n 302 - EVENT_FAN_PLUG_IN |\n 303 - EVENT_FAN_FAILURE_RECOVERED |\n 400 - EVENT_CPU_TEMPERATURE_ABOVE_CRITICAL |\n 401 - EVENT_CPU_TEMPERATURE_ABOVE_FATAL |\n 402 - EVENT_CPU_TEMPERATURE_ABOVE_CRITICAL_RECOVERED |\n 403 - EVENT_CPU_TEMPERATURE_ABOVE_FATAL_RECOVERED |\n 500 - EVENT_HW_DEVICE_RESET |\n 501 - EVENT_HW_DEVICE_TEMPERATURE_ABOVE_CRITICAL |\n 502 - EVENT_HW_DEVICE_TEMPERATURE_ABOVE_FATAL |\n 503 - EVENT_HW_DEVICE_TEMPERATURE_ABOVE_CRITICAL_RECOVERED |\n 504 - EVENT_HW_DEVICE_TEMPERATURE_ABOVE_FATAL_RECOVERED >\n 'is_configured': <bool>,\n 'thresholds': { # type: Thresholds\n '<i>ONEOF threshold\x3c/i>: <b>upper\x3c/b>': { # type: WaterMarks\n 'high': { # type: ValueType\n '<i>ONEOF val\x3c/i>: <b>int_val\x3c/b>': <int64>,\n '<i>ONEOF val\x3c/i>: <b>uint_val\x3c/b>': <uint64>,\n '<i>ONEOF val\x3c/i>: <b>float_val\x3c/b>': <float>,\n }\n 'low': { # type: ValueType\n '<i>ONEOF val\x3c/i>: <b>int_val\x3c/b>': <int64>,\n '<i>ONEOF val\x3c/i>: <b>uint_val\x3c/b>': <uint64>,\n '<i>ONEOF val\x3c/i>: <b>float_val\x3c/b>': <float>,\n }\n }\n '<i>ONEOF threshold\x3c/i>: <b>lower\x3c/b>': { # type: WaterMarks\n 'high': { # type: ValueType\n '<i>ONEOF val\x3c/i>: <b>int_val\x3c/b>': <int64>,\n '<i>ONEOF val\x3c/i>: <b>uint_val\x3c/b>': <uint64>,\n '<i>ONEOF val\x3c/i>: <b>float_val\x3c/b>': <float>,\n }\n 'low': { # type: ValueType\n '<i>ONEOF val\x3c/i>: <b>int_val\x3c/b>': <int64>,\n '<i>ONEOF val\x3c/i>: <b>uint_val\x3c/b>': <uint64>,\n '<i>ONEOF val\x3c/i>: <b>float_val\x3c/b>': <float>,\n }\n }\n }\n }\n ]\n }\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Event Mgmt Service List Events","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>UpdateEventsConfiguration\x3c/i> from <i>NativeEventsManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict: <b>Note\x3c/b>: Bold dictionary keys are cases of an ONEOF type that is not transmitted in gRPC.\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: EventsConfigurationRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n '<i>ONEOF operation\x3c/i>: <b>changes\x3c/b>': { # type: EventsCfg\n 'items': [ # list of:\n { # type: EventCfg\n 'event_id': < 0 - EVENT_NAME_UNDEFINED |\n 100 - EVENT_TRANSCEIVER_PLUG_OUT |\n 101 - EVENT_TRANSCEIVER_PLUG_IN |\n 102 - EVENT_TRANSCEIVER_VOLTAGE_ABOVE_THRESHOLD |\n 103 - EVENT_TRANSCEIVER_VOLTAGE_BELOW_THRESHOLD |\n 104 - EVENT_TRANSCEIVER_TEMPERATURE_ABOVE_THRESHOLD |\n 105 - EVENT_TRANSCEIVER_TEMPERATURE_BELOW_THRESHOLD |\n 106 - EVENT_TRANSCEIVER_CURRENT_ABOVE_THRESHOLD |\n 107 - EVENT_TRANSCEIVER_CURRENT_BELOW_THRESHOLD |\n 108 - EVENT_TRANSCEIVER_RX_POWER_ABOVE_THRESHOLD |\n 109 - EVENT_TRANSCEIVER_RX_POWER_BELOW_THRESHOLD |\n 110 - EVENT_TRANSCEIVER_TX_POWER_ABOVE_THRESHOLD |\n 111 - EVENT_TRANSCEIVER_TX_POWER_BELOW_THRESHOLD |\n 112 - EVENT_TRANSCEIVER_FAILURE |\n 113 - EVENT_TRANSCEIVER_VOLTAGE_ABOVE_THRESHOLD_RECOVERED |\n 114 - EVENT_TRANSCEIVER_VOLTAGE_BELOW_THRESHOLD_RECOVERED |\n 115 - EVENT_TRANSCEIVER_TEMPERATURE_ABOVE_THRESHOLD_RECOVERED |\n 116 - EVENT_TRANSCEIVER_TEMPERATURE_BELOW_THRESHOLD_RECOVERED |\n 117 - EVENT_TRANSCEIVER_CURRENT_ABOVE_THRESHOLD_RECOVERED |\n 118 - EVENT_TRANSCEIVER_CURRENT_BELOW_THRESHOLD_RECOVERED |\n 119 - EVENT_TRANSCEIVER_RX_POWER_ABOVE_THRESHOLD_RECOVERED |\n 120 - EVENT_TRANSCEIVER_RX_POWER_BELOW_THRESHOLD_RECOVERED |\n 121 - EVENT_TRANSCEIVER_TX_POWER_ABOVE_THRESHOLD_RECOVERED |\n 122 - EVENT_TRANSCEIVER_TX_POWER_BELOW_THRESHOLD_RECOVERED |\n 123 - EVENT_TRANSCEIVER_FAILURE_RECOVERED |\n 200 - EVENT_PSU_PLUG_OUT |\n 201 - EVENT_PSU_PLUG_IN |\n 202 - EVENT_PSU_FAILURE |\n 203 - EVENT_PSU_FAILURE_RECOVERED |\n 300 - EVENT_FAN_FAILURE |\n 301 - EVENT_FAN_PLUG_OUT |\n 302 - EVENT_FAN_PLUG_IN |\n 303 - EVENT_FAN_FAILURE_RECOVERED |\n 400 - EVENT_CPU_TEMPERATURE_ABOVE_CRITICAL |\n 401 - EVENT_CPU_TEMPERATURE_ABOVE_FATAL |\n 402 - EVENT_CPU_TEMPERATURE_ABOVE_CRITICAL_RECOVERED |\n 403 - EVENT_CPU_TEMPERATURE_ABOVE_FATAL_RECOVERED |\n 500 - EVENT_HW_DEVICE_RESET |\n 501 - EVENT_HW_DEVICE_TEMPERATURE_ABOVE_CRITICAL |\n 502 - EVENT_HW_DEVICE_TEMPERATURE_ABOVE_FATAL |\n 503 - EVENT_HW_DEVICE_TEMPERATURE_ABOVE_CRITICAL_RECOVERED |\n 504 - EVENT_HW_DEVICE_TEMPERATURE_ABOVE_FATAL_RECOVERED >\n 'is_configured': <bool>,\n 'thresholds': { # type: Thresholds\n '<i>ONEOF threshold\x3c/i>: <b>upper\x3c/b>': { # type: WaterMarks\n 'high': { # type: ValueType\n '<i>ONEOF val\x3c/i>: <b>int_val\x3c/b>': <int64>,\n '<i>ONEOF val\x3c/i>: <b>uint_val\x3c/b>': <uint64>,\n '<i>ONEOF val\x3c/i>: <b>float_val\x3c/b>': <float>,\n }\n 'low': { # type: ValueType\n '<i>ONEOF val\x3c/i>: <b>int_val\x3c/b>': <int64>,\n '<i>ONEOF val\x3c/i>: <b>uint_val\x3c/b>': <uint64>,\n '<i>ONEOF val\x3c/i>: <b>float_val\x3c/b>': <float>,\n }\n }\n '<i>ONEOF threshold\x3c/i>: <b>lower\x3c/b>': { # type: WaterMarks\n 'high': { # type: ValueType\n '<i>ONEOF val\x3c/i>: <b>int_val\x3c/b>': <int64>,\n '<i>ONEOF val\x3c/i>: <b>uint_val\x3c/b>': <uint64>,\n '<i>ONEOF val\x3c/i>: <b>float_val\x3c/b>': <float>,\n }\n 'low': { # type: ValueType\n '<i>ONEOF val\x3c/i>: <b>int_val\x3c/b>': <int64>,\n '<i>ONEOF val\x3c/i>: <b>uint_val\x3c/b>': <uint64>,\n '<i>ONEOF val\x3c/i>: <b>float_val\x3c/b>': <float>,\n }\n }\n }\n }\n ]\n }\n '<i>ONEOF operation\x3c/i>: <b>reset_to_default\x3c/b>': <bool>,\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: EventsConfigurationResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Event Mgmt Service Update Events Configuration","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>GetHWComponentInfo\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: HWComponentInfoGetRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'component_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'component_name': <string>,\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>: <b>Note\x3c/b>: Bold dictionary keys are cases of an ONEOF type that is not transmitted in gRPC.\x3c/p>\n<pre>\n[ # list of:\n { # type: HWComponentInfoGetResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'component': { # type: Component\n 'name': <string>,\n 'class': < 0 - COMPONENT_TYPE_UNDEFINED |\n 1 - COMPONENT_TYPE_UNKNOWN |\n 2 - COMPONENT_TYPE_CHASSIS |\n 3 - COMPONENT_TYPE_BACKPLANE |\n 4 - COMPONENT_TYPE_CONTAINER |\n 5 - COMPONENT_TYPE_POWER_SUPPLY |\n 6 - COMPONENT_TYPE_FAN |\n 7 - COMPONENT_TYPE_SENSOR |\n 8 - COMPONENT_TYPE_MODULE |\n 9 - COMPONENT_TYPE_PORT |\n 10 - COMPONENT_TYPE_CPU |\n 11 - COMPONENT_TYPE_BATTERY |\n 12 - COMPONENT_TYPE_STORAGE |\n 13 - COMPONENT_TYPE_MEMORY |\n 14 - COMPONENT_TYPE_TRANSCEIVER >\n 'description': <string>,\n 'parent': <string>,\n 'parent_rel_pos': <int32>,\n 'children': [ # list of:\n < recursive type: Component >\n ]\n 'hardware_rev': <string>,\n 'firmware_rev': <string>,\n 'software_rev': <string>,\n 'serial_num': <string>,\n 'mfg_name': <string>,\n 'model_name': <string>,\n 'alias': <string>,\n 'asset_id': <string>,\n 'is_fru': <bool>,\n 'mfg_date': <google.protobuf.Timestamp>,\n 'uri': { # type: Uri\n 'uri': <string>,\n }\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'state': { # type: ComponentState\n 'state_last_changed': <google.protobuf.Timestamp>,\n 'admin_state': < 0 - COMP_ADMIN_STATE_UNDEFINED |\n 1 - COMP_ADMIN_STATE_UNKNOWN |\n 2 - COMP_ADMIN_STATE_LOCKED |\n 3 - COMP_ADMIN_STATE_SHUTTING_DOWN |\n 4 - COMP_ADMIN_STATE_UNLOCKED >\n 'oper_state': < 0 - COMP_OPER_STATE_UNDEFINED |\n 1 - COMP_OPER_STATE_UNKNOWN |\n 2 - COMP_OPER_STATE_DISABLED |\n 3 - COMP_OPER_STATE_ENABLED |\n 4 - COMP_OPER_STATE_TESTING >\n 'usage_state': < 0 - COMP_USAGE_STATE_UNDEFINED |\n 1 - COMP_USAGE_STATE_UNKNOWN |\n 2 - COMP_USAGE_STATE_IDLE |\n 3 - COMP_USAGE_STATE_ACTIVE |\n 4 - COMP_USAGE_STATE_BUSY >\n 'alarm_state': < 0 - COMP_ALARM_STATE_UNDEFINED |\n 1 - COMP_ALARM_STATE_UNKNOWN |\n 2 - COMP_ALARM_STATE_UNDER_REPAIR |\n 3 - COMP_ALARM_STATE_CRITICAL |\n 4 - COMP_ALARM_STATE_MAJOR |\n 5 - COMP_ALARM_STATE_MINOR |\n 6 - COMP_ALARM_STATE_WARNING |\n 7 - COMP_ALARM_STATE_INDETERMINATE >\n 'standby_state': < 0 - COMP_STANDBY_STATE_UNDEFINED |\n 1 - COMP_STANDBY_STATE_UNKNOWN |\n 2 - COMP_STANDBY_STATE_HOT |\n 3 - COMP_STANDBY_STATE_COLD |\n 4 - COMP_STANDBY_STATE_PROVIDING_SERVICE >\n }\n 'sensor_data': [ # list of:\n { # type: ComponentSensorData\n 'value': <int32>,\n 'type': < 0 - VALUE_TYPE_UNDEFINED |\n 1 - VALUE_TYPE_OTHER |\n 2 - VALUE_TYPE_UNKNOWN |\n 3 - VALUE_TYPE_VOLTS_AC |\n 4 - VALUE_TYPE_VOLTS_DC |\n 5 - VALUE_TYPE_AMPERES |\n 6 - VALUE_TYPE_WATTS |\n 7 - VALUE_TYPE_HERTZ |\n 8 - VALUE_TYPE_CELSIUS |\n 9 - VALUE_TYPE_PERCENT_RH |\n 10 - VALUE_TYPE_RPM |\n 11 - VALUE_TYPE_CMM |\n 12 - VALUE_TYPE_TRUTH_VALUE >\n 'scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'precision': <int32>,\n 'status': < 0 - SENSOR_STATUS_UNDEFINED |\n 1 - SENSOR_STATUS_OK |\n 2 - SENSOR_STATUS_UNAVAILABLE |\n 3 - SENSOR_STATUS_NONOPERATIONAL >\n 'units_display': <string>,\n 'timestamp': <google.protobuf.Timestamp>,\n 'value_update_rate': <uint32>,\n 'data_type': <string>,\n }\n ]\n '<i>ONEOF specific\x3c/i>: <b>port_attr\x3c/b>': { # type: PortComponentAttributes\n 'connector_type': < 0 - CONNECTOR_TYPE_UNDEFINED |\n 1 - RJ45 |\n 2 - FIBER_LC |\n 3 - FIBER_SC_PC |\n 4 - FIBER_MPO >\n 'speed': < 0 - SPEED_UNDEFINED |\n 1 - DYNAMIC |\n 2 - GIGABIT_1 |\n 3 - GIGABIT_10 |\n 4 - GIGABIT_25 |\n 5 - GIGABIT_40 |\n 6 - GIGABIT_100 |\n 7 - GIGABIT_400 |\n 8 - MEGABIT_2500 |\n 9 - MEGABIT_1250 >\n 'protocol': < 0 - PROTOCOL_UNDEFINED |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - GFAST |\n 6 - SERIAL |\n 7 - EPON >\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>container_attr\x3c/b>': { # type: ContainerComponentAttributes\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>psu_attr\x3c/b>': { # type: PsuComponentAttributes\n 'supported_voltage': < 0 - SUPPORTED_VOLTAGE_UNDEFINED |\n 1 - V48 |\n 2 - V230 |\n 3 - V115 >\n }\n '<i>ONEOF specific\x3c/i>: <b>transceiver_attr\x3c/b>': { # type: TransceiverComponentsAttributes\n 'form_factor': < 0 - FORM_FACTOR_UNKNOWN |\n 1 - QSFP |\n 2 - QSFP_PLUS |\n 3 - QSFP28 |\n 4 - SFP |\n 5 - SFP_PLUS |\n 6 - XFP |\n 7 - CFP4 |\n 8 - CFP2 |\n 9 - CPAK |\n 10 - X2 |\n 11 - OTHER |\n 12 - CFP |\n 13 - CFP2_ACO |\n 14 - CFP2_DCO >\n 'trans_type': < 0 - TYPE_UNKNOWN |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - CPON |\n 6 - NG_PON2 |\n 7 - EPON >\n 'max_distance': <uint32>,\n 'max_distance_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'rx_wavelength': [ # list of:\n <uint32>,\n ]\n 'tx_wavelength': [ # list of:\n <uint32>,\n ]\n 'wavelength_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n }\n }\n 'reason_detail': <string>,\n }\n]\n\x3c/pre>","matched":true,"name":"Hw Management Service Get Hw Component Info","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>GetLogLevel\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: GetLogLevelRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'entities': [ # list of:\n <string>,\n ]\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: GetLogLevelResponse\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'logLevels': [ # list of:\n { # type: EntitiesLogLevel\n 'logLevel': < 0 - TRACE |\n 1 - DEBUG |\n 2 - INFO |\n 3 - WARN |\n 4 - ERROR >\n 'entities': [ # list of:\n <string>,\n ]\n }\n ]\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Get Log Level","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>GetLoggableEntities\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: GetLoggableEntitiesRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: GetLogLevelResponse\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'logLevels': [ # list of:\n { # type: EntitiesLogLevel\n 'logLevel': < 0 - TRACE |\n 1 - DEBUG |\n 2 - INFO |\n 3 - WARN |\n 4 - ERROR >\n 'entities': [ # list of:\n <string>,\n ]\n }\n ]\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Get Loggable Entities","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>GetLoggingEndpoint\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: HardwareID\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: GetLoggingEndpointResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'logging_endpoint': <string>,\n 'logging_protocol': <string>,\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Get Logging Endpoint","shortdoc":"","tags":[]},{"args":["**kwargs"],"doc":"<p>RPC <i>GetManagedDevices\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>: <i>none\x3c/i>\x3c/p>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>: <b>Note\x3c/b>: Bold dictionary keys are cases of an ONEOF type that is not transmitted in gRPC.\x3c/p>\n<pre>\n{ # type: ManagedDevicesResponse\n 'devices': [ # list of:\n { # type: ModifiableComponent\n 'name': <string>,\n 'class': < 0 - COMPONENT_TYPE_UNDEFINED |\n 1 - COMPONENT_TYPE_UNKNOWN |\n 2 - COMPONENT_TYPE_CHASSIS |\n 3 - COMPONENT_TYPE_BACKPLANE |\n 4 - COMPONENT_TYPE_CONTAINER |\n 5 - COMPONENT_TYPE_POWER_SUPPLY |\n 6 - COMPONENT_TYPE_FAN |\n 7 - COMPONENT_TYPE_SENSOR |\n 8 - COMPONENT_TYPE_MODULE |\n 9 - COMPONENT_TYPE_PORT |\n 10 - COMPONENT_TYPE_CPU |\n 11 - COMPONENT_TYPE_BATTERY |\n 12 - COMPONENT_TYPE_STORAGE |\n 13 - COMPONENT_TYPE_MEMORY |\n 14 - COMPONENT_TYPE_TRANSCEIVER >\n 'parent': { # type: Component\n 'name': <string>,\n 'class': < 0 - COMPONENT_TYPE_UNDEFINED |\n 1 - COMPONENT_TYPE_UNKNOWN |\n 2 - COMPONENT_TYPE_CHASSIS |\n 3 - COMPONENT_TYPE_BACKPLANE |\n 4 - COMPONENT_TYPE_CONTAINER |\n 5 - COMPONENT_TYPE_POWER_SUPPLY |\n 6 - COMPONENT_TYPE_FAN |\n 7 - COMPONENT_TYPE_SENSOR |\n 8 - COMPONENT_TYPE_MODULE |\n 9 - COMPONENT_TYPE_PORT |\n 10 - COMPONENT_TYPE_CPU |\n 11 - COMPONENT_TYPE_BATTERY |\n 12 - COMPONENT_TYPE_STORAGE |\n 13 - COMPONENT_TYPE_MEMORY |\n 14 - COMPONENT_TYPE_TRANSCEIVER >\n 'description': <string>,\n 'parent': <string>,\n 'parent_rel_pos': <int32>,\n 'children': [ # list of:\n < recursive type: Component >\n ]\n 'hardware_rev': <string>,\n 'firmware_rev': <string>,\n 'software_rev': <string>,\n 'serial_num': <string>,\n 'mfg_name': <string>,\n 'model_name': <string>,\n 'alias': <string>,\n 'asset_id': <string>,\n 'is_fru': <bool>,\n 'mfg_date': <google.protobuf.Timestamp>,\n 'uri': { # type: Uri\n 'uri': <string>,\n }\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'state': { # type: ComponentState\n 'state_last_changed': <google.protobuf.Timestamp>,\n 'admin_state': < 0 - COMP_ADMIN_STATE_UNDEFINED |\n 1 - COMP_ADMIN_STATE_UNKNOWN |\n 2 - COMP_ADMIN_STATE_LOCKED |\n 3 - COMP_ADMIN_STATE_SHUTTING_DOWN |\n 4 - COMP_ADMIN_STATE_UNLOCKED >\n 'oper_state': < 0 - COMP_OPER_STATE_UNDEFINED |\n 1 - COMP_OPER_STATE_UNKNOWN |\n 2 - COMP_OPER_STATE_DISABLED |\n 3 - COMP_OPER_STATE_ENABLED |\n 4 - COMP_OPER_STATE_TESTING >\n 'usage_state': < 0 - COMP_USAGE_STATE_UNDEFINED |\n 1 - COMP_USAGE_STATE_UNKNOWN |\n 2 - COMP_USAGE_STATE_IDLE |\n 3 - COMP_USAGE_STATE_ACTIVE |\n 4 - COMP_USAGE_STATE_BUSY >\n 'alarm_state': < 0 - COMP_ALARM_STATE_UNDEFINED |\n 1 - COMP_ALARM_STATE_UNKNOWN |\n 2 - COMP_ALARM_STATE_UNDER_REPAIR |\n 3 - COMP_ALARM_STATE_CRITICAL |\n 4 - COMP_ALARM_STATE_MAJOR |\n 5 - COMP_ALARM_STATE_MINOR |\n 6 - COMP_ALARM_STATE_WARNING |\n 7 - COMP_ALARM_STATE_INDETERMINATE >\n 'standby_state': < 0 - COMP_STANDBY_STATE_UNDEFINED |\n 1 - COMP_STANDBY_STATE_UNKNOWN |\n 2 - COMP_STANDBY_STATE_HOT |\n 3 - COMP_STANDBY_STATE_COLD |\n 4 - COMP_STANDBY_STATE_PROVIDING_SERVICE >\n }\n 'sensor_data': [ # list of:\n { # type: ComponentSensorData\n 'value': <int32>,\n 'type': < 0 - VALUE_TYPE_UNDEFINED |\n 1 - VALUE_TYPE_OTHER |\n 2 - VALUE_TYPE_UNKNOWN |\n 3 - VALUE_TYPE_VOLTS_AC |\n 4 - VALUE_TYPE_VOLTS_DC |\n 5 - VALUE_TYPE_AMPERES |\n 6 - VALUE_TYPE_WATTS |\n 7 - VALUE_TYPE_HERTZ |\n 8 - VALUE_TYPE_CELSIUS |\n 9 - VALUE_TYPE_PERCENT_RH |\n 10 - VALUE_TYPE_RPM |\n 11 - VALUE_TYPE_CMM |\n 12 - VALUE_TYPE_TRUTH_VALUE >\n 'scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'precision': <int32>,\n 'status': < 0 - SENSOR_STATUS_UNDEFINED |\n 1 - SENSOR_STATUS_OK |\n 2 - SENSOR_STATUS_UNAVAILABLE |\n 3 - SENSOR_STATUS_NONOPERATIONAL >\n 'units_display': <string>,\n 'timestamp': <google.protobuf.Timestamp>,\n 'value_update_rate': <uint32>,\n 'data_type': <string>,\n }\n ]\n '<i>ONEOF specific\x3c/i>: <b>port_attr\x3c/b>': { # type: PortComponentAttributes\n 'connector_type': < 0 - CONNECTOR_TYPE_UNDEFINED |\n 1 - RJ45 |\n 2 - FIBER_LC |\n 3 - FIBER_SC_PC |\n 4 - FIBER_MPO >\n 'speed': < 0 - SPEED_UNDEFINED |\n 1 - DYNAMIC |\n 2 - GIGABIT_1 |\n 3 - GIGABIT_10 |\n 4 - GIGABIT_25 |\n 5 - GIGABIT_40 |\n 6 - GIGABIT_100 |\n 7 - GIGABIT_400 |\n 8 - MEGABIT_2500 |\n 9 - MEGABIT_1250 >\n 'protocol': < 0 - PROTOCOL_UNDEFINED |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - GFAST |\n 6 - SERIAL |\n 7 - EPON >\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>container_attr\x3c/b>': { # type: ContainerComponentAttributes\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>psu_attr\x3c/b>': { # type: PsuComponentAttributes\n 'supported_voltage': < 0 - SUPPORTED_VOLTAGE_UNDEFINED |\n 1 - V48 |\n 2 - V230 |\n 3 - V115 >\n }\n '<i>ONEOF specific\x3c/i>: <b>transceiver_attr\x3c/b>': { # type: TransceiverComponentsAttributes\n 'form_factor': < 0 - FORM_FACTOR_UNKNOWN |\n 1 - QSFP |\n 2 - QSFP_PLUS |\n 3 - QSFP28 |\n 4 - SFP |\n 5 - SFP_PLUS |\n 6 - XFP |\n 7 - CFP4 |\n 8 - CFP2 |\n 9 - CPAK |\n 10 - X2 |\n 11 - OTHER |\n 12 - CFP |\n 13 - CFP2_ACO |\n 14 - CFP2_DCO >\n 'trans_type': < 0 - TYPE_UNKNOWN |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - CPON |\n 6 - NG_PON2 |\n 7 - EPON >\n 'max_distance': <uint32>,\n 'max_distance_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'rx_wavelength': [ # list of:\n <uint32>,\n ]\n 'tx_wavelength': [ # list of:\n <uint32>,\n ]\n 'wavelength_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n }\n }\n 'parent_rel_pos': <int32>,\n 'alias': <string>,\n 'asset_id': <string>,\n 'uri': { # type: Uri\n 'uri': <string>,\n }\n 'admin_state': < 0 - COMP_ADMIN_STATE_UNDEFINED |\n 1 - COMP_ADMIN_STATE_UNKNOWN |\n 2 - COMP_ADMIN_STATE_LOCKED |\n 3 - COMP_ADMIN_STATE_SHUTTING_DOWN |\n 4 - COMP_ADMIN_STATE_UNLOCKED >\n }\n ]\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Get Managed Devices","shortdoc":"","tags":[]},{"args":["**kwargs"],"doc":"<p>RPC <i>GetMsgBusEndpoint\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>: <i>none\x3c/i>\x3c/p>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: GetMsgBusEndpointResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'msgbus_endpoint': <string>,\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Get Msg Bus Endpoint","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>GetPhysicalInventory\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: PhysicalInventoryRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>: <b>Note\x3c/b>: Bold dictionary keys are cases of an ONEOF type that is not transmitted in gRPC.\x3c/p>\n<pre>\n[ # list of:\n { # type: PhysicalInventoryResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'inventory': { # type: Hardware\n 'last_change': <google.protobuf.Timestamp>,\n 'root': { # type: Component\n 'name': <string>,\n 'class': < 0 - COMPONENT_TYPE_UNDEFINED |\n 1 - COMPONENT_TYPE_UNKNOWN |\n 2 - COMPONENT_TYPE_CHASSIS |\n 3 - COMPONENT_TYPE_BACKPLANE |\n 4 - COMPONENT_TYPE_CONTAINER |\n 5 - COMPONENT_TYPE_POWER_SUPPLY |\n 6 - COMPONENT_TYPE_FAN |\n 7 - COMPONENT_TYPE_SENSOR |\n 8 - COMPONENT_TYPE_MODULE |\n 9 - COMPONENT_TYPE_PORT |\n 10 - COMPONENT_TYPE_CPU |\n 11 - COMPONENT_TYPE_BATTERY |\n 12 - COMPONENT_TYPE_STORAGE |\n 13 - COMPONENT_TYPE_MEMORY |\n 14 - COMPONENT_TYPE_TRANSCEIVER >\n 'description': <string>,\n 'parent': <string>,\n 'parent_rel_pos': <int32>,\n 'children': [ # list of:\n < recursive type: Component >\n ]\n 'hardware_rev': <string>,\n 'firmware_rev': <string>,\n 'software_rev': <string>,\n 'serial_num': <string>,\n 'mfg_name': <string>,\n 'model_name': <string>,\n 'alias': <string>,\n 'asset_id': <string>,\n 'is_fru': <bool>,\n 'mfg_date': <google.protobuf.Timestamp>,\n 'uri': { # type: Uri\n 'uri': <string>,\n }\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'state': { # type: ComponentState\n 'state_last_changed': <google.protobuf.Timestamp>,\n 'admin_state': < 0 - COMP_ADMIN_STATE_UNDEFINED |\n 1 - COMP_ADMIN_STATE_UNKNOWN |\n 2 - COMP_ADMIN_STATE_LOCKED |\n 3 - COMP_ADMIN_STATE_SHUTTING_DOWN |\n 4 - COMP_ADMIN_STATE_UNLOCKED >\n 'oper_state': < 0 - COMP_OPER_STATE_UNDEFINED |\n 1 - COMP_OPER_STATE_UNKNOWN |\n 2 - COMP_OPER_STATE_DISABLED |\n 3 - COMP_OPER_STATE_ENABLED |\n 4 - COMP_OPER_STATE_TESTING >\n 'usage_state': < 0 - COMP_USAGE_STATE_UNDEFINED |\n 1 - COMP_USAGE_STATE_UNKNOWN |\n 2 - COMP_USAGE_STATE_IDLE |\n 3 - COMP_USAGE_STATE_ACTIVE |\n 4 - COMP_USAGE_STATE_BUSY >\n 'alarm_state': < 0 - COMP_ALARM_STATE_UNDEFINED |\n 1 - COMP_ALARM_STATE_UNKNOWN |\n 2 - COMP_ALARM_STATE_UNDER_REPAIR |\n 3 - COMP_ALARM_STATE_CRITICAL |\n 4 - COMP_ALARM_STATE_MAJOR |\n 5 - COMP_ALARM_STATE_MINOR |\n 6 - COMP_ALARM_STATE_WARNING |\n 7 - COMP_ALARM_STATE_INDETERMINATE >\n 'standby_state': < 0 - COMP_STANDBY_STATE_UNDEFINED |\n 1 - COMP_STANDBY_STATE_UNKNOWN |\n 2 - COMP_STANDBY_STATE_HOT |\n 3 - COMP_STANDBY_STATE_COLD |\n 4 - COMP_STANDBY_STATE_PROVIDING_SERVICE >\n }\n 'sensor_data': [ # list of:\n { # type: ComponentSensorData\n 'value': <int32>,\n 'type': < 0 - VALUE_TYPE_UNDEFINED |\n 1 - VALUE_TYPE_OTHER |\n 2 - VALUE_TYPE_UNKNOWN |\n 3 - VALUE_TYPE_VOLTS_AC |\n 4 - VALUE_TYPE_VOLTS_DC |\n 5 - VALUE_TYPE_AMPERES |\n 6 - VALUE_TYPE_WATTS |\n 7 - VALUE_TYPE_HERTZ |\n 8 - VALUE_TYPE_CELSIUS |\n 9 - VALUE_TYPE_PERCENT_RH |\n 10 - VALUE_TYPE_RPM |\n 11 - VALUE_TYPE_CMM |\n 12 - VALUE_TYPE_TRUTH_VALUE >\n 'scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'precision': <int32>,\n 'status': < 0 - SENSOR_STATUS_UNDEFINED |\n 1 - SENSOR_STATUS_OK |\n 2 - SENSOR_STATUS_UNAVAILABLE |\n 3 - SENSOR_STATUS_NONOPERATIONAL >\n 'units_display': <string>,\n 'timestamp': <google.protobuf.Timestamp>,\n 'value_update_rate': <uint32>,\n 'data_type': <string>,\n }\n ]\n '<i>ONEOF specific\x3c/i>: <b>port_attr\x3c/b>': { # type: PortComponentAttributes\n 'connector_type': < 0 - CONNECTOR_TYPE_UNDEFINED |\n 1 - RJ45 |\n 2 - FIBER_LC |\n 3 - FIBER_SC_PC |\n 4 - FIBER_MPO >\n 'speed': < 0 - SPEED_UNDEFINED |\n 1 - DYNAMIC |\n 2 - GIGABIT_1 |\n 3 - GIGABIT_10 |\n 4 - GIGABIT_25 |\n 5 - GIGABIT_40 |\n 6 - GIGABIT_100 |\n 7 - GIGABIT_400 |\n 8 - MEGABIT_2500 |\n 9 - MEGABIT_1250 >\n 'protocol': < 0 - PROTOCOL_UNDEFINED |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - GFAST |\n 6 - SERIAL |\n 7 - EPON >\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>container_attr\x3c/b>': { # type: ContainerComponentAttributes\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>psu_attr\x3c/b>': { # type: PsuComponentAttributes\n 'supported_voltage': < 0 - SUPPORTED_VOLTAGE_UNDEFINED |\n 1 - V48 |\n 2 - V230 |\n 3 - V115 >\n }\n '<i>ONEOF specific\x3c/i>: <b>transceiver_attr\x3c/b>': { # type: TransceiverComponentsAttributes\n 'form_factor': < 0 - FORM_FACTOR_UNKNOWN |\n 1 - QSFP |\n 2 - QSFP_PLUS |\n 3 - QSFP28 |\n 4 - SFP |\n 5 - SFP_PLUS |\n 6 - XFP |\n 7 - CFP4 |\n 8 - CFP2 |\n 9 - CPAK |\n 10 - X2 |\n 11 - OTHER |\n 12 - CFP |\n 13 - CFP2_ACO |\n 14 - CFP2_DCO >\n 'trans_type': < 0 - TYPE_UNKNOWN |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - CPON |\n 6 - NG_PON2 |\n 7 - EPON >\n 'max_distance': <uint32>,\n 'max_distance_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'rx_wavelength': [ # list of:\n <uint32>,\n ]\n 'tx_wavelength': [ # list of:\n <uint32>,\n ]\n 'wavelength_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n }\n }\n 'last_booted': <google.protobuf.Timestamp>,\n }\n 'reason_detail': <string>,\n }\n]\n\x3c/pre>","matched":true,"name":"Hw Management Service Get Physical Inventory","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>SetHWComponentInfo\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict: <b>Note\x3c/b>: Bold dictionary keys are cases of an ONEOF type that is not transmitted in gRPC.\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: HWComponentInfoSetRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'component_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'component_name': <string>,\n 'changes': { # type: ModifiableComponent\n 'name': <string>,\n 'class': < 0 - COMPONENT_TYPE_UNDEFINED |\n 1 - COMPONENT_TYPE_UNKNOWN |\n 2 - COMPONENT_TYPE_CHASSIS |\n 3 - COMPONENT_TYPE_BACKPLANE |\n 4 - COMPONENT_TYPE_CONTAINER |\n 5 - COMPONENT_TYPE_POWER_SUPPLY |\n 6 - COMPONENT_TYPE_FAN |\n 7 - COMPONENT_TYPE_SENSOR |\n 8 - COMPONENT_TYPE_MODULE |\n 9 - COMPONENT_TYPE_PORT |\n 10 - COMPONENT_TYPE_CPU |\n 11 - COMPONENT_TYPE_BATTERY |\n 12 - COMPONENT_TYPE_STORAGE |\n 13 - COMPONENT_TYPE_MEMORY |\n 14 - COMPONENT_TYPE_TRANSCEIVER >\n 'parent': { # type: Component\n 'name': <string>,\n 'class': < 0 - COMPONENT_TYPE_UNDEFINED |\n 1 - COMPONENT_TYPE_UNKNOWN |\n 2 - COMPONENT_TYPE_CHASSIS |\n 3 - COMPONENT_TYPE_BACKPLANE |\n 4 - COMPONENT_TYPE_CONTAINER |\n 5 - COMPONENT_TYPE_POWER_SUPPLY |\n 6 - COMPONENT_TYPE_FAN |\n 7 - COMPONENT_TYPE_SENSOR |\n 8 - COMPONENT_TYPE_MODULE |\n 9 - COMPONENT_TYPE_PORT |\n 10 - COMPONENT_TYPE_CPU |\n 11 - COMPONENT_TYPE_BATTERY |\n 12 - COMPONENT_TYPE_STORAGE |\n 13 - COMPONENT_TYPE_MEMORY |\n 14 - COMPONENT_TYPE_TRANSCEIVER >\n 'description': <string>,\n 'parent': <string>,\n 'parent_rel_pos': <int32>,\n 'children': [ # list of:\n < recursive type: Component >\n ]\n 'hardware_rev': <string>,\n 'firmware_rev': <string>,\n 'software_rev': <string>,\n 'serial_num': <string>,\n 'mfg_name': <string>,\n 'model_name': <string>,\n 'alias': <string>,\n 'asset_id': <string>,\n 'is_fru': <bool>,\n 'mfg_date': <google.protobuf.Timestamp>,\n 'uri': { # type: Uri\n 'uri': <string>,\n }\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'state': { # type: ComponentState\n 'state_last_changed': <google.protobuf.Timestamp>,\n 'admin_state': < 0 - COMP_ADMIN_STATE_UNDEFINED |\n 1 - COMP_ADMIN_STATE_UNKNOWN |\n 2 - COMP_ADMIN_STATE_LOCKED |\n 3 - COMP_ADMIN_STATE_SHUTTING_DOWN |\n 4 - COMP_ADMIN_STATE_UNLOCKED >\n 'oper_state': < 0 - COMP_OPER_STATE_UNDEFINED |\n 1 - COMP_OPER_STATE_UNKNOWN |\n 2 - COMP_OPER_STATE_DISABLED |\n 3 - COMP_OPER_STATE_ENABLED |\n 4 - COMP_OPER_STATE_TESTING >\n 'usage_state': < 0 - COMP_USAGE_STATE_UNDEFINED |\n 1 - COMP_USAGE_STATE_UNKNOWN |\n 2 - COMP_USAGE_STATE_IDLE |\n 3 - COMP_USAGE_STATE_ACTIVE |\n 4 - COMP_USAGE_STATE_BUSY >\n 'alarm_state': < 0 - COMP_ALARM_STATE_UNDEFINED |\n 1 - COMP_ALARM_STATE_UNKNOWN |\n 2 - COMP_ALARM_STATE_UNDER_REPAIR |\n 3 - COMP_ALARM_STATE_CRITICAL |\n 4 - COMP_ALARM_STATE_MAJOR |\n 5 - COMP_ALARM_STATE_MINOR |\n 6 - COMP_ALARM_STATE_WARNING |\n 7 - COMP_ALARM_STATE_INDETERMINATE >\n 'standby_state': < 0 - COMP_STANDBY_STATE_UNDEFINED |\n 1 - COMP_STANDBY_STATE_UNKNOWN |\n 2 - COMP_STANDBY_STATE_HOT |\n 3 - COMP_STANDBY_STATE_COLD |\n 4 - COMP_STANDBY_STATE_PROVIDING_SERVICE >\n }\n 'sensor_data': [ # list of:\n { # type: ComponentSensorData\n 'value': <int32>,\n 'type': < 0 - VALUE_TYPE_UNDEFINED |\n 1 - VALUE_TYPE_OTHER |\n 2 - VALUE_TYPE_UNKNOWN |\n 3 - VALUE_TYPE_VOLTS_AC |\n 4 - VALUE_TYPE_VOLTS_DC |\n 5 - VALUE_TYPE_AMPERES |\n 6 - VALUE_TYPE_WATTS |\n 7 - VALUE_TYPE_HERTZ |\n 8 - VALUE_TYPE_CELSIUS |\n 9 - VALUE_TYPE_PERCENT_RH |\n 10 - VALUE_TYPE_RPM |\n 11 - VALUE_TYPE_CMM |\n 12 - VALUE_TYPE_TRUTH_VALUE >\n 'scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'precision': <int32>,\n 'status': < 0 - SENSOR_STATUS_UNDEFINED |\n 1 - SENSOR_STATUS_OK |\n 2 - SENSOR_STATUS_UNAVAILABLE |\n 3 - SENSOR_STATUS_NONOPERATIONAL >\n 'units_display': <string>,\n 'timestamp': <google.protobuf.Timestamp>,\n 'value_update_rate': <uint32>,\n 'data_type': <string>,\n }\n ]\n '<i>ONEOF specific\x3c/i>: <b>port_attr\x3c/b>': { # type: PortComponentAttributes\n 'connector_type': < 0 - CONNECTOR_TYPE_UNDEFINED |\n 1 - RJ45 |\n 2 - FIBER_LC |\n 3 - FIBER_SC_PC |\n 4 - FIBER_MPO >\n 'speed': < 0 - SPEED_UNDEFINED |\n 1 - DYNAMIC |\n 2 - GIGABIT_1 |\n 3 - GIGABIT_10 |\n 4 - GIGABIT_25 |\n 5 - GIGABIT_40 |\n 6 - GIGABIT_100 |\n 7 - GIGABIT_400 |\n 8 - MEGABIT_2500 |\n 9 - MEGABIT_1250 >\n 'protocol': < 0 - PROTOCOL_UNDEFINED |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - GFAST |\n 6 - SERIAL |\n 7 - EPON >\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>container_attr\x3c/b>': { # type: ContainerComponentAttributes\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>psu_attr\x3c/b>': { # type: PsuComponentAttributes\n 'supported_voltage': < 0 - SUPPORTED_VOLTAGE_UNDEFINED |\n 1 - V48 |\n 2 - V230 |\n 3 - V115 >\n }\n '<i>ONEOF specific\x3c/i>: <b>transceiver_attr\x3c/b>': { # type: TransceiverComponentsAttributes\n 'form_factor': < 0 - FORM_FACTOR_UNKNOWN |\n 1 - QSFP |\n 2 - QSFP_PLUS |\n 3 - QSFP28 |\n 4 - SFP |\n 5 - SFP_PLUS |\n 6 - XFP |\n 7 - CFP4 |\n 8 - CFP2 |\n 9 - CPAK |\n 10 - X2 |\n 11 - OTHER |\n 12 - CFP |\n 13 - CFP2_ACO |\n 14 - CFP2_DCO >\n 'trans_type': < 0 - TYPE_UNKNOWN |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - CPON |\n 6 - NG_PON2 |\n 7 - EPON >\n 'max_distance': <uint32>,\n 'max_distance_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'rx_wavelength': [ # list of:\n <uint32>,\n ]\n 'tx_wavelength': [ # list of:\n <uint32>,\n ]\n 'wavelength_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n }\n }\n 'parent_rel_pos': <int32>,\n 'alias': <string>,\n 'asset_id': <string>,\n 'uri': { # type: Uri\n 'uri': <string>,\n }\n 'admin_state': < 0 - COMP_ADMIN_STATE_UNDEFINED |\n 1 - COMP_ADMIN_STATE_UNKNOWN |\n 2 - COMP_ADMIN_STATE_LOCKED |\n 3 - COMP_ADMIN_STATE_SHUTTING_DOWN |\n 4 - COMP_ADMIN_STATE_UNLOCKED >\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: HWComponentInfoSetResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Set Hw Component Info","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>SetLogLevel\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: SetLogLevelRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'loglevels': [ # list of:\n { # type: EntitiesLogLevel\n 'logLevel': < 0 - TRACE |\n 1 - DEBUG |\n 2 - INFO |\n 3 - WARN |\n 4 - ERROR >\n 'entities': [ # list of:\n <string>,\n ]\n }\n ]\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: SetLogLevelResponse\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Set Log Level","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>SetLoggingEndpoint\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: SetLoggingEndpointRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'logging_endpoint': <string>,\n 'logging_protocol': <string>,\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: SetRemoteEndpointResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Set Logging Endpoint","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>SetMsgBusEndpoint\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: SetMsgBusEndpointRequest\n 'msgbus_endpoint': <string>,\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: SetRemoteEndpointResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Set Msg Bus Endpoint","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>StartManagingDevice\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict: <b>Note\x3c/b>: Bold dictionary keys are cases of an ONEOF type that is not transmitted in gRPC.\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: ModifiableComponent\n 'name': <string>,\n 'class': < 0 - COMPONENT_TYPE_UNDEFINED |\n 1 - COMPONENT_TYPE_UNKNOWN |\n 2 - COMPONENT_TYPE_CHASSIS |\n 3 - COMPONENT_TYPE_BACKPLANE |\n 4 - COMPONENT_TYPE_CONTAINER |\n 5 - COMPONENT_TYPE_POWER_SUPPLY |\n 6 - COMPONENT_TYPE_FAN |\n 7 - COMPONENT_TYPE_SENSOR |\n 8 - COMPONENT_TYPE_MODULE |\n 9 - COMPONENT_TYPE_PORT |\n 10 - COMPONENT_TYPE_CPU |\n 11 - COMPONENT_TYPE_BATTERY |\n 12 - COMPONENT_TYPE_STORAGE |\n 13 - COMPONENT_TYPE_MEMORY |\n 14 - COMPONENT_TYPE_TRANSCEIVER >\n 'parent': { # type: Component\n 'name': <string>,\n 'class': < 0 - COMPONENT_TYPE_UNDEFINED |\n 1 - COMPONENT_TYPE_UNKNOWN |\n 2 - COMPONENT_TYPE_CHASSIS |\n 3 - COMPONENT_TYPE_BACKPLANE |\n 4 - COMPONENT_TYPE_CONTAINER |\n 5 - COMPONENT_TYPE_POWER_SUPPLY |\n 6 - COMPONENT_TYPE_FAN |\n 7 - COMPONENT_TYPE_SENSOR |\n 8 - COMPONENT_TYPE_MODULE |\n 9 - COMPONENT_TYPE_PORT |\n 10 - COMPONENT_TYPE_CPU |\n 11 - COMPONENT_TYPE_BATTERY |\n 12 - COMPONENT_TYPE_STORAGE |\n 13 - COMPONENT_TYPE_MEMORY |\n 14 - COMPONENT_TYPE_TRANSCEIVER >\n 'description': <string>,\n 'parent': <string>,\n 'parent_rel_pos': <int32>,\n 'children': [ # list of:\n < recursive type: Component >\n ]\n 'hardware_rev': <string>,\n 'firmware_rev': <string>,\n 'software_rev': <string>,\n 'serial_num': <string>,\n 'mfg_name': <string>,\n 'model_name': <string>,\n 'alias': <string>,\n 'asset_id': <string>,\n 'is_fru': <bool>,\n 'mfg_date': <google.protobuf.Timestamp>,\n 'uri': { # type: Uri\n 'uri': <string>,\n }\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'state': { # type: ComponentState\n 'state_last_changed': <google.protobuf.Timestamp>,\n 'admin_state': < 0 - COMP_ADMIN_STATE_UNDEFINED |\n 1 - COMP_ADMIN_STATE_UNKNOWN |\n 2 - COMP_ADMIN_STATE_LOCKED |\n 3 - COMP_ADMIN_STATE_SHUTTING_DOWN |\n 4 - COMP_ADMIN_STATE_UNLOCKED >\n 'oper_state': < 0 - COMP_OPER_STATE_UNDEFINED |\n 1 - COMP_OPER_STATE_UNKNOWN |\n 2 - COMP_OPER_STATE_DISABLED |\n 3 - COMP_OPER_STATE_ENABLED |\n 4 - COMP_OPER_STATE_TESTING >\n 'usage_state': < 0 - COMP_USAGE_STATE_UNDEFINED |\n 1 - COMP_USAGE_STATE_UNKNOWN |\n 2 - COMP_USAGE_STATE_IDLE |\n 3 - COMP_USAGE_STATE_ACTIVE |\n 4 - COMP_USAGE_STATE_BUSY >\n 'alarm_state': < 0 - COMP_ALARM_STATE_UNDEFINED |\n 1 - COMP_ALARM_STATE_UNKNOWN |\n 2 - COMP_ALARM_STATE_UNDER_REPAIR |\n 3 - COMP_ALARM_STATE_CRITICAL |\n 4 - COMP_ALARM_STATE_MAJOR |\n 5 - COMP_ALARM_STATE_MINOR |\n 6 - COMP_ALARM_STATE_WARNING |\n 7 - COMP_ALARM_STATE_INDETERMINATE >\n 'standby_state': < 0 - COMP_STANDBY_STATE_UNDEFINED |\n 1 - COMP_STANDBY_STATE_UNKNOWN |\n 2 - COMP_STANDBY_STATE_HOT |\n 3 - COMP_STANDBY_STATE_COLD |\n 4 - COMP_STANDBY_STATE_PROVIDING_SERVICE >\n }\n 'sensor_data': [ # list of:\n { # type: ComponentSensorData\n 'value': <int32>,\n 'type': < 0 - VALUE_TYPE_UNDEFINED |\n 1 - VALUE_TYPE_OTHER |\n 2 - VALUE_TYPE_UNKNOWN |\n 3 - VALUE_TYPE_VOLTS_AC |\n 4 - VALUE_TYPE_VOLTS_DC |\n 5 - VALUE_TYPE_AMPERES |\n 6 - VALUE_TYPE_WATTS |\n 7 - VALUE_TYPE_HERTZ |\n 8 - VALUE_TYPE_CELSIUS |\n 9 - VALUE_TYPE_PERCENT_RH |\n 10 - VALUE_TYPE_RPM |\n 11 - VALUE_TYPE_CMM |\n 12 - VALUE_TYPE_TRUTH_VALUE >\n 'scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'precision': <int32>,\n 'status': < 0 - SENSOR_STATUS_UNDEFINED |\n 1 - SENSOR_STATUS_OK |\n 2 - SENSOR_STATUS_UNAVAILABLE |\n 3 - SENSOR_STATUS_NONOPERATIONAL >\n 'units_display': <string>,\n 'timestamp': <google.protobuf.Timestamp>,\n 'value_update_rate': <uint32>,\n 'data_type': <string>,\n }\n ]\n '<i>ONEOF specific\x3c/i>: <b>port_attr\x3c/b>': { # type: PortComponentAttributes\n 'connector_type': < 0 - CONNECTOR_TYPE_UNDEFINED |\n 1 - RJ45 |\n 2 - FIBER_LC |\n 3 - FIBER_SC_PC |\n 4 - FIBER_MPO >\n 'speed': < 0 - SPEED_UNDEFINED |\n 1 - DYNAMIC |\n 2 - GIGABIT_1 |\n 3 - GIGABIT_10 |\n 4 - GIGABIT_25 |\n 5 - GIGABIT_40 |\n 6 - GIGABIT_100 |\n 7 - GIGABIT_400 |\n 8 - MEGABIT_2500 |\n 9 - MEGABIT_1250 >\n 'protocol': < 0 - PROTOCOL_UNDEFINED |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - GFAST |\n 6 - SERIAL |\n 7 - EPON >\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>container_attr\x3c/b>': { # type: ContainerComponentAttributes\n 'physical_label': <string>,\n }\n '<i>ONEOF specific\x3c/i>: <b>psu_attr\x3c/b>': { # type: PsuComponentAttributes\n 'supported_voltage': < 0 - SUPPORTED_VOLTAGE_UNDEFINED |\n 1 - V48 |\n 2 - V230 |\n 3 - V115 >\n }\n '<i>ONEOF specific\x3c/i>: <b>transceiver_attr\x3c/b>': { # type: TransceiverComponentsAttributes\n 'form_factor': < 0 - FORM_FACTOR_UNKNOWN |\n 1 - QSFP |\n 2 - QSFP_PLUS |\n 3 - QSFP28 |\n 4 - SFP |\n 5 - SFP_PLUS |\n 6 - XFP |\n 7 - CFP4 |\n 8 - CFP2 |\n 9 - CPAK |\n 10 - X2 |\n 11 - OTHER |\n 12 - CFP |\n 13 - CFP2_ACO |\n 14 - CFP2_DCO >\n 'trans_type': < 0 - TYPE_UNKNOWN |\n 1 - ETHERNET |\n 2 - GPON |\n 3 - XGPON |\n 4 - XGSPON |\n 5 - CPON |\n 6 - NG_PON2 |\n 7 - EPON >\n 'max_distance': <uint32>,\n 'max_distance_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'rx_wavelength': [ # list of:\n <uint32>,\n ]\n 'tx_wavelength': [ # list of:\n <uint32>,\n ]\n 'wavelength_scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n }\n }\n 'parent_rel_pos': <int32>,\n 'alias': <string>,\n 'asset_id': <string>,\n 'uri': { # type: Uri\n 'uri': <string>,\n }\n 'admin_state': < 0 - COMP_ADMIN_STATE_UNDEFINED |\n 1 - COMP_ADMIN_STATE_UNKNOWN |\n 2 - COMP_ADMIN_STATE_LOCKED |\n 3 - COMP_ADMIN_STATE_SHUTTING_DOWN |\n 4 - COMP_ADMIN_STATE_UNLOCKED >\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n[ # list of:\n { # type: StartManagingDeviceResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'reason_detail': <string>,\n }\n]\n\x3c/pre>","matched":true,"name":"Hw Management Service Start Managing Device","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>StopManagingDevice\x3c/i> from <i>NativeHWManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: StopManagingDeviceRequest\n 'name': <string>,\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: StopManagingDeviceResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Management Service Stop Managing Device","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>GetMetric\x3c/i> from <i>NativeMetricsManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: GetMetricRequest\n 'meta_data': { # type: MetricMetaData\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'component_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'component_name': <string>,\n }\n 'metric_id': < 0 - METRIC_NAME_UNDEFINED |\n 1 - METRIC_FAN_SPEED |\n 100 - METRIC_CPU_TEMP |\n 101 - METRIC_CPU_USAGE_PERCENTAGE |\n 200 - METRIC_TRANSCEIVER_TEMP |\n 201 - METRIC_TRANSCEIVER_VOLTAGE |\n 202 - METRIC_TRANSCEIVER_BIAS |\n 203 - METRIC_TRANSCEIVER_RX_POWER |\n 204 - METRIC_TRANSCEIVER_TX_POWER |\n 205 - METRIC_TRANSCEIVER_WAVELENGTH |\n 300 - METRIC_DISK_TEMP |\n 301 - METRIC_DISK_CAPACITY |\n 302 - METRIC_DISK_USAGE |\n 303 - METRIC_DISK_USAGE_PERCENTAGE |\n 304 - METRIC_DISK_READ_WRITE_PERCENTAGE |\n 305 - METRIC_DISK_FAULTY_CELLS_PERCENTAGE |\n 400 - METRIC_RAM_TEMP |\n 401 - METRIC_RAM_CAPACITY |\n 402 - METRIC_RAM_USAGE |\n 403 - METRIC_RAM_USAGE_PERCENTAGE |\n 500 - METRIC_POWER_MAX |\n 501 - METRIC_POWER_USAGE |\n 502 - METRIC_POWER_USAGE_PERCENTAGE |\n 600 - METRIC_INNER_SURROUNDING_TEMP >\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: GetMetricResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'metric': { # type: Metric\n 'metric_id': < 0 - METRIC_NAME_UNDEFINED |\n 1 - METRIC_FAN_SPEED |\n 100 - METRIC_CPU_TEMP |\n 101 - METRIC_CPU_USAGE_PERCENTAGE |\n 200 - METRIC_TRANSCEIVER_TEMP |\n 201 - METRIC_TRANSCEIVER_VOLTAGE |\n 202 - METRIC_TRANSCEIVER_BIAS |\n 203 - METRIC_TRANSCEIVER_RX_POWER |\n 204 - METRIC_TRANSCEIVER_TX_POWER |\n 205 - METRIC_TRANSCEIVER_WAVELENGTH |\n 300 - METRIC_DISK_TEMP |\n 301 - METRIC_DISK_CAPACITY |\n 302 - METRIC_DISK_USAGE |\n 303 - METRIC_DISK_USAGE_PERCENTAGE |\n 304 - METRIC_DISK_READ_WRITE_PERCENTAGE |\n 305 - METRIC_DISK_FAULTY_CELLS_PERCENTAGE |\n 400 - METRIC_RAM_TEMP |\n 401 - METRIC_RAM_CAPACITY |\n 402 - METRIC_RAM_USAGE |\n 403 - METRIC_RAM_USAGE_PERCENTAGE |\n 500 - METRIC_POWER_MAX |\n 501 - METRIC_POWER_USAGE |\n 502 - METRIC_POWER_USAGE_PERCENTAGE |\n 600 - METRIC_INNER_SURROUNDING_TEMP >\n 'metric_metadata': { # type: MetricMetaData\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'component_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'component_name': <string>,\n }\n 'value': { # type: ComponentSensorData\n 'value': <int32>,\n 'type': < 0 - VALUE_TYPE_UNDEFINED |\n 1 - VALUE_TYPE_OTHER |\n 2 - VALUE_TYPE_UNKNOWN |\n 3 - VALUE_TYPE_VOLTS_AC |\n 4 - VALUE_TYPE_VOLTS_DC |\n 5 - VALUE_TYPE_AMPERES |\n 6 - VALUE_TYPE_WATTS |\n 7 - VALUE_TYPE_HERTZ |\n 8 - VALUE_TYPE_CELSIUS |\n 9 - VALUE_TYPE_PERCENT_RH |\n 10 - VALUE_TYPE_RPM |\n 11 - VALUE_TYPE_CMM |\n 12 - VALUE_TYPE_TRUTH_VALUE >\n 'scale': < 0 - VALUE_SCALE_UNDEFINED |\n 1 - VALUE_SCALE_YOCTO |\n 2 - VALUE_SCALE_ZEPTO |\n 3 - VALUE_SCALE_ATTO |\n 4 - VALUE_SCALE_FEMTO |\n 5 - VALUE_SCALE_PICO |\n 6 - VALUE_SCALE_NANO |\n 7 - VALUE_SCALE_MICRO |\n 8 - VALUE_SCALE_MILLI |\n 9 - VALUE_SCALE_UNITS |\n 10 - VALUE_SCALE_KILO |\n 11 - VALUE_SCALE_MEGA |\n 12 - VALUE_SCALE_GIGA |\n 13 - VALUE_SCALE_TERA |\n 14 - VALUE_SCALE_PETA |\n 15 - VALUE_SCALE_EXA |\n 16 - VALUE_SCALE_ZETTA |\n 17 - VALUE_SCALE_YOTTA >\n 'precision': <int32>,\n 'status': < 0 - SENSOR_STATUS_UNDEFINED |\n 1 - SENSOR_STATUS_OK |\n 2 - SENSOR_STATUS_UNAVAILABLE |\n 3 - SENSOR_STATUS_NONOPERATIONAL >\n 'units_display': <string>,\n 'timestamp': <google.protobuf.Timestamp>,\n 'value_update_rate': <uint32>,\n 'data_type': <string>,\n }\n }\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Metrics Mgmt Service Get Metric","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>ListMetrics\x3c/i> from <i>NativeMetricsManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: HardwareID\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: ListMetricsResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'metrics': { # type: MetricsConfig\n 'metrics': [ # list of:\n { # type: MetricConfig\n 'metric_id': < 0 - METRIC_NAME_UNDEFINED |\n 1 - METRIC_FAN_SPEED |\n 100 - METRIC_CPU_TEMP |\n 101 - METRIC_CPU_USAGE_PERCENTAGE |\n 200 - METRIC_TRANSCEIVER_TEMP |\n 201 - METRIC_TRANSCEIVER_VOLTAGE |\n 202 - METRIC_TRANSCEIVER_BIAS |\n 203 - METRIC_TRANSCEIVER_RX_POWER |\n 204 - METRIC_TRANSCEIVER_TX_POWER |\n 205 - METRIC_TRANSCEIVER_WAVELENGTH |\n 300 - METRIC_DISK_TEMP |\n 301 - METRIC_DISK_CAPACITY |\n 302 - METRIC_DISK_USAGE |\n 303 - METRIC_DISK_USAGE_PERCENTAGE |\n 304 - METRIC_DISK_READ_WRITE_PERCENTAGE |\n 305 - METRIC_DISK_FAULTY_CELLS_PERCENTAGE |\n 400 - METRIC_RAM_TEMP |\n 401 - METRIC_RAM_CAPACITY |\n 402 - METRIC_RAM_USAGE |\n 403 - METRIC_RAM_USAGE_PERCENTAGE |\n 500 - METRIC_POWER_MAX |\n 501 - METRIC_POWER_USAGE |\n 502 - METRIC_POWER_USAGE_PERCENTAGE |\n 600 - METRIC_INNER_SURROUNDING_TEMP >\n 'is_configured': <bool>,\n 'poll_interval': <uint32>,\n }\n ]\n }\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Metrics Mgmt Service List Metrics","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>UpdateMetricsConfiguration\x3c/i> from <i>NativeMetricsManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict: <b>Note\x3c/b>: Bold dictionary keys are cases of an ONEOF type that is not transmitted in gRPC.\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: MetricsConfigurationRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n '<i>ONEOF operation\x3c/i>: <b>changes\x3c/b>': { # type: MetricsConfig\n 'metrics': [ # list of:\n { # type: MetricConfig\n 'metric_id': < 0 - METRIC_NAME_UNDEFINED |\n 1 - METRIC_FAN_SPEED |\n 100 - METRIC_CPU_TEMP |\n 101 - METRIC_CPU_USAGE_PERCENTAGE |\n 200 - METRIC_TRANSCEIVER_TEMP |\n 201 - METRIC_TRANSCEIVER_VOLTAGE |\n 202 - METRIC_TRANSCEIVER_BIAS |\n 203 - METRIC_TRANSCEIVER_RX_POWER |\n 204 - METRIC_TRANSCEIVER_TX_POWER |\n 205 - METRIC_TRANSCEIVER_WAVELENGTH |\n 300 - METRIC_DISK_TEMP |\n 301 - METRIC_DISK_CAPACITY |\n 302 - METRIC_DISK_USAGE |\n 303 - METRIC_DISK_USAGE_PERCENTAGE |\n 304 - METRIC_DISK_READ_WRITE_PERCENTAGE |\n 305 - METRIC_DISK_FAULTY_CELLS_PERCENTAGE |\n 400 - METRIC_RAM_TEMP |\n 401 - METRIC_RAM_CAPACITY |\n 402 - METRIC_RAM_USAGE |\n 403 - METRIC_RAM_USAGE_PERCENTAGE |\n 500 - METRIC_POWER_MAX |\n 501 - METRIC_POWER_USAGE |\n 502 - METRIC_POWER_USAGE_PERCENTAGE |\n 600 - METRIC_INNER_SURROUNDING_TEMP >\n 'is_configured': <bool>,\n 'poll_interval': <uint32>,\n }\n ]\n }\n '<i>ONEOF operation\x3c/i>: <b>reset_to_default\x3c/b>': <bool>,\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: MetricsConfigurationResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Hw Metrics Mgmt Service Update Metrics Configuration","shortdoc":"","tags":[]},{"args":[],"doc":"<p>Retrieve the version of the currently running library instance.\x3c/p>\n<p><b>Return\x3c/b>: version string consisting of three dot-separated numbers (x.y.z)\x3c/p>","matched":true,"name":"Library Version Get","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>ActivateImage\x3c/i> from <i>NativeSoftwareManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: HardwareID\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n[ # list of:\n { # type: ImageStatus\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - ERROR_IN_REQUEST |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_IN_WRONG_STATE |\n 4 - INVALID_IMAGE |\n 5 - WRONG_IMAGE_CHECKSUM |\n 6 - OPERATION_ALREADY_IN_PROGRESS |\n 7 - UNKNOWN_DEVICE |\n 8 - DEVICE_NOT_REACHABLE >\n 'state': < 0 - UNDEFINED_STATE |\n 1 - COPYING_IMAGE |\n 2 - INSTALLING_IMAGE |\n 3 - COMMITTING_IMAGE |\n 4 - REBOOTING_DEVICE |\n 5 - UPGRADE_COMPLETE |\n 6 - UPGRADE_FAILED |\n 7 - ACTIVATION_COMPLETE |\n 8 - ACTIVATION_FAILED >\n 'description': <string>,\n 'reason_detail': <string>,\n }\n]\n\x3c/pre>","matched":true,"name":"Sw Management Service Activate Image","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>DownloadImage\x3c/i> from <i>NativeSoftwareManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: DownloadImageRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'image_info': { # type: ImageInformation\n 'image': { # type: ImageVersion\n 'image_name': <string>,\n 'version': <string>,\n }\n 'image_install_script': <string>,\n 'image_url': <string>,\n 'sha256sum': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n[ # list of:\n { # type: ImageStatus\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - ERROR_IN_REQUEST |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_IN_WRONG_STATE |\n 4 - INVALID_IMAGE |\n 5 - WRONG_IMAGE_CHECKSUM |\n 6 - OPERATION_ALREADY_IN_PROGRESS |\n 7 - UNKNOWN_DEVICE |\n 8 - DEVICE_NOT_REACHABLE >\n 'state': < 0 - UNDEFINED_STATE |\n 1 - COPYING_IMAGE |\n 2 - INSTALLING_IMAGE |\n 3 - COMMITTING_IMAGE |\n 4 - REBOOTING_DEVICE |\n 5 - UPGRADE_COMPLETE |\n 6 - UPGRADE_FAILED |\n 7 - ACTIVATION_COMPLETE |\n 8 - ACTIVATION_FAILED >\n 'description': <string>,\n 'reason_detail': <string>,\n }\n]\n\x3c/pre>","matched":true,"name":"Sw Management Service Download Image","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>GetSoftwareVersion\x3c/i> from <i>NativeSoftwareManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: HardwareID\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: GetSoftwareVersionInformationResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'info': { # type: SoftwareVersionInformation\n 'active_versions': [ # list of:\n { # type: ImageVersion\n 'image_name': <string>,\n 'version': <string>,\n }\n ]\n 'standby_versions': [ # list of:\n { # type: ImageVersion\n 'image_name': <string>,\n 'version': <string>,\n }\n ]\n }\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Sw Management Service Get Software Version","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>GetStartupConfigurationInfo\x3c/i> from <i>NativeSoftwareManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: StartupConfigInfoRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n{ # type: StartupConfigInfoResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'config_url': <string>,\n 'version': <string>,\n 'reason_detail': <string>,\n}\n\x3c/pre>","matched":true,"name":"Sw Management Service Get Startup Configuration Info","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>RevertToStandbyImage\x3c/i> from <i>NativeSoftwareManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: HardwareID\n 'uuid': { # type: Uuid\n 'uuid': <string>,\n }\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n[ # list of:\n { # type: ImageStatus\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - ERROR_IN_REQUEST |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_IN_WRONG_STATE |\n 4 - INVALID_IMAGE |\n 5 - WRONG_IMAGE_CHECKSUM |\n 6 - OPERATION_ALREADY_IN_PROGRESS |\n 7 - UNKNOWN_DEVICE |\n 8 - DEVICE_NOT_REACHABLE >\n 'state': < 0 - UNDEFINED_STATE |\n 1 - COPYING_IMAGE |\n 2 - INSTALLING_IMAGE |\n 3 - COMMITTING_IMAGE |\n 4 - REBOOTING_DEVICE |\n 5 - UPGRADE_COMPLETE |\n 6 - UPGRADE_FAILED |\n 7 - ACTIVATION_COMPLETE |\n 8 - ACTIVATION_FAILED >\n 'description': <string>,\n 'reason_detail': <string>,\n }\n]\n\x3c/pre>","matched":true,"name":"Sw Management Service Revert To Standby Image","shortdoc":"","tags":[]},{"args":["param_dict","**kwargs"],"doc":"<p>RPC <i>UpdateStartupConfiguration\x3c/i> from <i>NativeSoftwareManagementService\x3c/i>.\x3c/p>\n<p><b>Parameters\x3c/b>:\x3c/p>\n<ul>\n<li>param_dict:\x3c/li>\n\x3c/ul>\n<pre>\n{ # type: ConfigRequest\n 'device_uuid': { # type: Uuid\n 'uuid': <string>,\n }\n 'config_url': <string>,\n}\n\x3c/pre>\n<p><b>Named parameters\x3c/b>:\x3c/p>\n<ul>\n<li>return_enum_integer: <bool> or <string>; Whether or not to return the enum values as integer values rather than their labels. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>return_defaults: <bool> or <string>; Whether or not to return the default values. Default: <i>${FALSE}\x3c/i> or <i>false\x3c/i>.\x3c/li>\n\x3c/ul>\n<ul>\n<li>timeout: <int> or <string>; Number of seconds to wait for the response. Default: The timeout value set by keywords <i>Connection Open\x3c/i> and <i>Connection Parameters Set\x3c/i>.\x3c/li>\n\x3c/ul>\n<p><b>Return\x3c/b>:\x3c/p>\n<pre>\n[ # list of:\n { # type: ConfigResponse\n 'status': < 0 - UNDEFINED_STATUS |\n 1 - OK_STATUS |\n 2 - ERROR_STATUS >\n 'reason': < 0 - UNDEFINED_REASON |\n 1 - UNKNOWN_DEVICE |\n 2 - INTERNAL_ERROR |\n 3 - DEVICE_UNREACHABLE >\n 'reason_detail': <string>,\n }\n]\n\x3c/pre>","matched":true,"name":"Sw Management Service Update Startup Configuration","shortdoc":"","tags":[]}],"name":"grpc_robot.Dmi","named_args":true,"scope":"test suite","version":"unknown"};

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

</script>

</head>

<body>

<h1>Opening library documentation failed</h1>

558

<ul>

559

<li>Verify that you have <b>JavaScript enabled</b> in your browser.</li>

560

<li>Make sure you are using a <b>modern enough browser</b>. If using Internet Explorer, version 8 or newer is required.</li>

561

<li>Check are there messages in your browser's <b>JavaScript error log</b>. Please report the problem if you suspect you have encountered a bug.</li>

</ul>

</div>

// Not using jQuery here for speed and to support ancient browsers.

567

document.getElementById('javascript-disabled').style.display = 'none';

</script>

$(document).ready(function() {

572

parseTemplates();

573

document.title = libdoc.name;

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

574

renderTemplate('base', libdoc, $('body'));

575

if (libdoc.inits.length) {

576

renderTemplate('importing', libdoc);

577

}

578

renderTemplate('shortcuts', libdoc);

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

579

if (libdoc.contains_tags) {

580

renderTemplate('tags', libdoc);

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

581

}

582

renderTemplate('keywords', libdoc);

583

renderTemplate('footer', libdoc);

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

584

scrollToHash();

Andrea Campanella

8147751

2022-02-07 13:05:57 +0000

[diff] [blame]

585

$(document).bind('keydown', handleKeydown);

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

586

});

587

588

function parseTemplates() {

589

$('script[type="text/x-jquery-tmpl"]').map(function (idx, elem) {

590

$.template(elem.id, elem.text);

});

}

function renderTemplate(name, arguments, container) {

595

if (!container) {

596

container = $('#' + name + '-container');

597

container.empty();

598

}

599

if (!arguments.search) {

600

arguments.search = false;

601

}

602

$.tmpl(name + '-template', arguments).appendTo(container);

603

}

604

Andrea Campanella

8147751

2022-02-07 13:05:57 +0000

[diff] [blame]

605

function handleKeydown(event) {

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

606

event = event || window.event;

607

var keyCode = event.keyCode || event.which;

608

if (keyCode === 27) // esc

609

setTimeout(closeSearch, 0);

610

if (keyCode === 83 && $('#search').is(':hidden')) // s

611

setTimeout(openSearch, 0);

612

}

613

614

function scrollToHash() {

615

if (window.location.hash) {

616

var hash = window.location.hash.substring(1).replace('+', ' ');

617

window.location.hash = '';

618

window.location.hash = hash;

}

}

Andrea Campanella

2022-02-07 13:05:57 +0000

[diff] [blame]

622

function tagSearch(tag) {

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

623

var include = {tags: true, tagsExact: true};

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

624

markMatches(tag, include);

625

highlightMatches(tag, include);

626

$('#keywords-container').find('.kw-row').addClass('hide-unmatched');

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

627

}

628

629

function doSearch() {

630

var string = $('#search-string').val();

631

var include = getIncludesAndDisableIfOnlyOneLeft();

632

if (string) {

633

markMatches(string, include);

634

highlightMatches(string, include);

635

setMatchVisibility();

} else {

resetKeywords();

}

}

function getIncludesAndDisableIfOnlyOneLeft() {

642

var name = $('#include-name');

643

var args = $('#include-args');

644

var doc = $('#include-doc');

645

var tags = $('#include-tags');

646

var include = {name: name.prop('checked'),

647

args: args.prop('checked'),

648

doc: doc.prop('checked'),

649

tags: !!tags.prop('checked')};

650

if ((!include.name) && (!include.args) && (!include.doc)) {

651

tags.prop('disabled', true);

652

} else if ((!include.name) && (!include.args) && (!include.tags)) {

653

doc.prop('disabled', true);

654

} else if ((!include.name) && (!include.doc) && (!include.tags)) {

655

args.prop('disabled', true);

656

} else if ((!include.args) && (!include.doc) && (!include.tags)) {

657

name.prop('disabled', true);

658

} else {

659

name.prop('disabled', false);

660

args.prop('disabled', false);

661

doc.prop('disabled', false);

662

tags.prop('disabled', false);

}

return include;

}

function markMatches(pattern, include) {

668

pattern = util.regexpEscape(pattern);

669

if (include.tagsExact) {

670

pattern = '^' + pattern + '$';

671

}

672

var regexp = new RegExp(pattern, 'i');

673

var test = regexp.test.bind(regexp);

674

var result = {contains_tags: libdoc.contains_tags};

675

var matchCount = 0;

676

result.keywords = util.map(libdoc.keywords, function (kw) {

677

kw = $.extend({}, kw);

678

kw.matched = (include.name && test(kw.name) ||

679

include.args && test(kw.args) ||

680

include.doc && test($(kw.doc).text()) ||

681

include.tags && util.any(util.map(kw.tags, test)));

if (kw.matched)

matchCount++;

return kw

});

renderTemplate('shortcuts', result);

687

renderTemplate('keywords', result);

688

if (libdoc.contains_tags) {

689

renderTemplate('tags', libdoc);

690

}

691

var ending = matchCount != 1 ? 's.' : '.';

692

$('#match-count').show().text(matchCount + ' matched keyword' + ending);

693

$('#altogether-count').hide();

694

if (matchCount == 0)

695

$('#keywords-container').find('table').empty();

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

696

}

697

698

function highlightMatches(string, include) {

699

var shortcuts = $('#shortcuts-container').find('.match');

700

var keywords = $('#keywords-container').find('.match');

701

if (include.name) {

702

shortcuts.highlight(string);

703

keywords.find('.kw').highlight(string);

704

}

705

if (include.args) {

706

keywords.find('.args').highlight(string);

707

}

708

if (include.doc) {

709

keywords.find('.doc').highlight(string);

710

}

711

if (include.tags) {

712

var matches = keywords.find('.tags').find('a').add(

713

$('#tags-container').find('a'));

714

if (include.tagsExact) {

715

matches = matches.filter(function (index, tag) {

716

return $(tag).text().toUpperCase() == string.toUpperCase();

717

});

718

}

719

matches.highlight(string);

}

}

function openSearch() {

724

$('#search').show();

725

$('#open-search').hide();

726

$('#search-string').focus().select();

727

$(document).scrollTop($("#Shortcuts").offset().top);

728

}

729

730

function closeSearch() {

731

$('#search').hide();

732

$('#open-search').show();

733

}

734

735

function resetSearch() {

736

$('#search-string').val('');

Andrea Campanella

8147751

2022-02-07 13:05:57 +0000

[diff] [blame]

737

$('#include-name').prop('checked', true);

738

$('#include-args').prop('checked', true);

739

$('#include-doc').prop('checked', true);

740

$('#hide-unmatched').prop('checked', false);

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

resetKeywords();

}

function resetKeywords() {

745

renderTemplate('shortcuts', libdoc);

746

renderTemplate('keywords', libdoc);

747

if (libdoc.contains_tags) {

748

renderTemplate('tags', libdoc);

749

}

750

$('#match-count').hide();

751

$('#altogether-count').show();

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

752

}

753

754

function setMatchVisibility() {

755

var kws = $('#keywords-container').find('.kw-row');

756

var hide = $('#hide-unmatched').prop('checked');

757

kws.toggleClass('hide-unmatched', hide);

758

}

759

760

// http://stackoverflow.com/a/18484799

761

var delay = (function () {

762

var timer = 0;

763

return function(callback, ms) {

764

clearTimeout(timer);

765

timer = setTimeout(callback, ms);

};

})();

</script>

{{if version}}<tr><th>Library version:</th><td>${version}</td></tr>{{/if}}

775

{{if scope}}<tr><th>Library scope:</th><td>${scope}</td></tr>{{/if}}

776

<tr><th>Named arguments:</th><td>{{if named_args}}supported{{else}}not supported{{/if}}</td></tr>

777

</table>

778

779

<h2 id="Introduction">Introduction</h2>

</div>

<legend id="search-title">Search keywords</legend>

790

791

792

<legend>Search from</legend>

<label for="include-args">Arguments</label>

797

798

<label for="include-doc">Documentation</label>

</fieldset>

<label for="hide-unmatched">Hide unmatched keywords</label>

806

807

<input type="button" value="Reset" onclick="resetSearch()"

808

title="Reset search">

809

<input type="button" value="Close" onclick="closeSearch()"

810

title="Close search (shortcut: <Esc>)">

</div>

</fieldset>

</form>

</script>

<h2 id="Importing">Importing</h2>

819

820

<tr>

821

<th class="args">Arguments</th>

822

<th class="doc">Documentation</th>

</tr>

Andrea Campanella

2022-02-07 13:05:57 +0000

[diff] [blame]

828

<span>${$value}</span>{{if $index < args.length-1}}, {{/if}}

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

829

830

</td>

831

<td class="doc">{{html $value.doc}}</td>

</tr>

</table>

</script>

<h2 id="Shortcuts">Shortcuts</h2>

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

839

840

841

<a href="#${encodeURIComponent($value.name)}"

842

class="{{if $value.matched === false}}no-{{/if}}match"

843

title="${$value.shortdoc}">${$value.name}</a>

Andrea Campanella

8147751

2022-02-07 13:05:57 +0000

[diff] [blame]

844

{{if $index < keywords.length-1}} · {{/if}}

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

</div>

</script>

Martin Cosyns

2021-09-27 16:24:30 +0000

[diff] [blame]

851

852

853

<a href="javascript:tagSearch('${$value}')"

Andrea Campanella

8147751

2022-02-07 13:05:57 +0000

[diff] [blame]

854

title="Show tests with this tag">${$value}</a> ·

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

855

856

<a href="javascript:resetKeywords()" class="normal-first-letter"

Andrea Campanella

8147751

2022-02-07 13:05:57 +0000

[diff] [blame]

857

title="Show all tests">[Reset]</a>

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

</div>

</script>

<h2 id="Keywords">Keywords</h2>

863

864

<tr>

865

<th class="kw">Keyword</th>

866

<th class="args">Arguments</th>

<th class="doc">Documentation</th>

</tr>

</table>

</script>

<a name="${name}" href="#${encodeURIComponent(name)}"

882

title="Link to this keyword">${name}</a>

</td>

Andrea Campanella

2022-02-07 13:05:57 +0000

[diff] [blame]

886

<span>${$value}</span>{{if $index < args.length-1}}, {{/if}}

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

</td>

<a href="javascript:tagSearch('${$value}')"

Andrea Campanella

8147751

2022-02-07 13:05:57 +0000

[diff] [blame]

893

title="Show tests with this tag">${$value}</a>{{if $index < tags.length-1}}, {{/if}}

Martin Cosyns

0efdc87

2021-09-27 16:24:30 +0000

[diff] [blame]

</td>

</tr>

</script>

<span id="altogether-count">Altogether ${keywords.length} keywords.</span>

905

906

<br>

907

Generated by <a href="http://robotframework.org/robotframework/#built-in-tools">Libdoc</a> on ${generated}.

</p>

</script>

</body>

</html>