Skip to content

Commit a260157

Browse files
raulillo82raulillo82
authored
Merge pull request #66 from uyuni-project/uyuni-2025.05-api-ghpages
Uyuni 2025.05 API gh pages
2 parents 67cbb45 + 2869e80 commit a260157

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+9621
-2022
lines changed

‎uyuni/api/access.html‎

Lines changed: 901 additions & 0 deletions
Large diffs are not rendered by default.

‎uyuni/api/actionchain.html‎

Lines changed: 121 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<title>actionchain
77
| Uyuni API Documentation</title> <link rel="canonical" href="https://www.uyuni-project.org/uyuni-docs-api/uyuni/api/actionchain.html">
8-
<link rel="prev" href="faqs.html">
8+
<link rel="prev" href="access.html">
99
<link rel="next" href="activationkey.html">
10-
<meta name="generator" content="Antora 3.1.7">
10+
<meta name="generator" content="Antora 3.1.10">
1111
<link rel="stylesheet" href="../../_/css/site.css">
1212
<link rel="stylesheet" href="../../_/css/search.css">
1313
<link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon">
@@ -18,21 +18,22 @@
1818
<link href="https://documentation.suse.com/docserv/res/fonts/poppins/poppins.css" rel="stylesheet">
1919
<!-- <link href="https://fonts.googleapis.com/css?family=Montserrat|Roboto&display=swap" rel="stylesheet"> -->
2020
<link rel="stylesheet" href="../../_/css/vendor/light.css">
21+
<link rel="stylesheet" href="../../_/css/vendor/tabs.css">
2122
<script src="/docserv/res/lightheaded/analytics.js"
2223
type="text/javascript"></script>
2324
<script>var uiRootPath = '../../_'</script>
2425
</head>
2526
<body class="article">
2627
<header class="header">
2728
<nav class="navbar">
28-
<div class="navbar-brand">
29-
<div class="navbar-item">
30-
<a class=" navbar-logo" href="https://www.uyuni-project.org/"><img class="logo"
31-
src="../../_/img/uyuni_logo.png" /></a>
32-
</div>
29+
<div class="navbar-brand">
30+
<div class="navbar-item">
31+
<a class=" navbar-logo" href="https://www.uyuni-project.org/"><img
32+
class="logo" src="../../_/img/uyuni_logo.png"/></a>
33+
</div>
3334
<div class="navbar-item search hide-for-print">
3435
<div id="search-field" class="field">
35-
<input id="search-input" type="text" placeholder="Search the docs" >
36+
<input id="search-input" type="text" placeholder="Search the docs">
3637
</div>
3738
</div>
3839
<button class="navbar-burger" data-target="topbar-nav">
@@ -41,29 +42,61 @@
4142
<span></span>
4243
</button>
4344
</div>
44-
<div id="topbar-nav" class="navbar-menu">
45-
<div class="navbar-end">
46-
<div class="navbar-item has-dropdown is-hoverable">
47-
<div class="navbar-link">Resources</div>
48-
<div class="navbar-dropdown">
49-
50-
<a class="navbar-item" href="https://github.com/uyuni-project/uyuni-docs"><i
51-
class="fab fa-github"></i>&nbsp;Uyuni Project</a>
52-
<a class="navbar-item" href="https://github.com/uyuni-project/uyuni-docs/issues"><i
53-
class="fab fa-github"></i>&nbsp;Report Issue</a>
54-
<a class="navbar-item" href="https://github.com/uyuni-project/uyuni-docs/wiki"><i
55-
class="fas fa-user-edit"></i>&nbsp;Contribute</a>
45+
<div id="topbar-nav" class="navbar-menu">
46+
<div class="navbar-end">
47+
<div class="navbar-item has-dropdown is-hoverable">
48+
<div class="navbar-link"><img src="../../_/img/resources.png" class="langIcon Resurces" alt="Resources" title="Resources"></div>
49+
<div class="navbar-dropdown">
50+
<!-- <div class="navbar-item"><strong>Resources</strong></div> -->
51+
<a class="navbar-item" href="https://github.com/uyuni-project/uyuni-docs"><i
52+
class="fab fa-github"></i>&nbsp;uyuni-docs</a>
53+
<a class="navbar-item" href="https://github.com/uyuni-project/uyuni-docs/issues"><i
54+
class="fab fa-github"></i>&nbsp;Report Issue</a>
55+
<a class="navbar-item"
56+
href="https://github.com/uyuni-project/uyuni-docs/wiki"><i
57+
class="fas fa-user-edit"></i>&nbsp;Contribute</a>
58+
</div>
59+
</div>
60+
<div class="navbar-item has-dropdown is-hoverable">
61+
<div class="navbar-link"><img src="../../_/img/language.png" class="langIcon Language" alt="Language" title="Language"></div>
62+
<div class="navbar-dropdown">
63+
<!-- </div><div>Icons made by <a href="https://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div> -->
64+
<a role="button" class="navbar-item" id="en" onclick="selectLanguage(this.id)"><img src="../../_/img/engFlag.svg" class="langIcon english">&nbsp;English</a>
65+
<!-- LANGUAGESELECTOR -->
66+
</div>
67+
</div>
68+
<div></div>
5669
</div>
57-
</div>
5870
</div>
59-
</div>
60-
<a href="https://twitter.com/uyuniproject?lang=en">
71+
<a href="https://twitter.com/uyuniproject?lang=en">
6172
<img class="x-logo" src="../../_/img/x-logo-white.png">
6273
</a>
63-
</div>
74+
75+
<!-- <div id="topbar-nav" class="navbar-menu">
76+
<div class="navbar-end">
77+
78+
</div>
79+
<div class="navbar-item">
80+
<span class="control">
81+
</span>
82+
</div>
83+
<div class="navbar-item">
84+
<span class="control">
85+
</span>
86+
</div>
87+
<div class="navbar-item">
88+
<span class="control">
89+
</span>
90+
</div>
91+
<div class="navbar-item">
92+
<span class="control">
93+
</span>
94+
</div>
95+
</div> -->
6496
</div>
6597
</nav>
66-
</header><div class="body">
98+
</header>
99+
<div class="body">
67100
<div class="nav-container" data-component="uyuni" data-version="">
68101
<aside class="nav">
69102
<div class="panels">
@@ -83,6 +116,9 @@ <h3 class="title"><a href="../index.html">Uyuni API</a></h3>
83116
<li class="nav-item" data-depth="1">
84117
<a class="nav-link" href="faqs.html">FAQ</a>
85118
</li>
119+
<li class="nav-item" data-depth="1">
120+
<a class="nav-link" href="access.html">access</a>
121+
</li>
86122
<li class="nav-item is-current-page" data-depth="1">
87123
<a class="nav-link" href="actionchain.html">actionchain</a>
88124
</li>
@@ -98,12 +134,18 @@ <h3 class="title"><a href="../index.html">Uyuni API</a></h3>
98134
<li class="nav-item" data-depth="1">
99135
<a class="nav-link" href="admin.monitoring.html">admin.monitoring</a>
100136
</li>
137+
<li class="nav-item" data-depth="1">
138+
<a class="nav-link" href="admin.payg.html">admin.payg</a>
139+
</li>
101140
<li class="nav-item" data-depth="1">
102141
<a class="nav-link" href="ansible.html">ansible</a>
103142
</li>
104143
<li class="nav-item" data-depth="1">
105144
<a class="nav-link" href="api.html">api</a>
106145
</li>
146+
<li class="nav-item" data-depth="1">
147+
<a class="nav-link" href="apilist.html">apilist.adoc</a>
148+
</li>
107149
<li class="nav-item" data-depth="1">
108150
<a class="nav-link" href="audit.html">audit</a>
109151
</li>
@@ -212,6 +254,9 @@ <h3 class="title"><a href="../index.html">Uyuni API</a></h3>
212254
<li class="nav-item" data-depth="1">
213255
<a class="nav-link" href="recurring.highstate.html">recurring.highstate</a>
214256
</li>
257+
<li class="nav-item" data-depth="1">
258+
<a class="nav-link" href="recurring.playbook.html">recurring.playbook</a>
259+
</li>
215260
<li class="nav-item" data-depth="1">
216261
<a class="nav-link" href="recurringaction.html">recurringaction</a>
217262
</li>
@@ -236,6 +281,9 @@ <h3 class="title"><a href="../index.html">Uyuni API</a></h3>
236281
<li class="nav-item" data-depth="1">
237282
<a class="nav-link" href="sync.slave.html">sync.slave</a>
238283
</li>
284+
<li class="nav-item" data-depth="1">
285+
<a class="nav-link" href="sync.hub.html">sync.hub</a>
286+
</li>
239287
<li class="nav-item" data-depth="1">
240288
<a class="nav-link" href="system.html">system</a>
241289
</li>
@@ -272,6 +320,9 @@ <h3 class="title"><a href="../index.html">Uyuni API</a></h3>
272320
<li class="nav-item" data-depth="1">
273321
<a class="nav-link" href="user.external.html">user.external</a>
274322
</li>
323+
<li class="nav-item" data-depth="1">
324+
<a class="nav-link" href="user.notifications.html">user.notifications</a>
325+
</li>
275326
<li class="nav-item" data-depth="1">
276327
<a class="nav-link" href="virtualhostmanager.html">virtualhostmanager</a>
277328
</li>
@@ -323,6 +374,9 @@ <h2 id="_available_methods"><a class="anchor" href="#_available_methods"></a><a
323374
<div class="ulist">
324375
<ul>
325376
<li>
377+
<p><a href="#apidoc-actionchain-addApplyHighstate-loggedInUser-sid-chainLabel">addApplyHighstate</a></p>
378+
</li>
379+
<li>
326380
<p><a href="#apidoc-actionchain-addConfigurationDeployment-loggedInUser-chainLabel-sid-revisionSpecifiers">addConfigurationDeployment</a></p>
327381
</li>
328382
<li>
@@ -395,6 +449,46 @@ <h2 id="_description"><a class="anchor" href="#_description"></a><a class="link"
395449
</div>
396450
</div>
397451
<div class="sect1">
452+
<h2 id="apidoc-actionchain-addApplyHighstate-loggedInUser-sid-chainLabel"><a class="anchor" href="#apidoc-actionchain-addApplyHighstate-loggedInUser-sid-chainLabel"></a><a class="link" href="#apidoc-actionchain-addApplyHighstate-loggedInUser-sid-chainLabel">Method: addApplyHighstate</a></h2>
453+
<div class="sectionbody">
454+
<div class="paragraph">
455+
<p>HTTP <code>POST</code></p>
456+
</div>
457+
<div class="paragraph">
458+
<p>Description:</p>
459+
</div>
460+
<div class="paragraph">
461+
<p>Adds an action to apply highstate on the system to an Action Chain.</p>
462+
</div>
463+
<div class="paragraph">
464+
<p>Parameters:</p>
465+
</div>
466+
<div class="ulist">
467+
<ul>
468+
<li>
469+
<p><span class="string">string</span> sessionKey</p>
470+
</li>
471+
<li>
472+
<p><span class="int">int</span> sid - System ID</p>
473+
</li>
474+
<li>
475+
<p><span class="string">string</span> chainLabel - Label of the chain</p>
476+
</li>
477+
</ul>
478+
</div>
479+
<div class="paragraph">
480+
<p>Returns:</p>
481+
</div>
482+
<div class="ulist">
483+
<ul>
484+
<li>
485+
<p><span class="int">int</span> actionId - The id of the action or throw an exception</p>
486+
</li>
487+
</ul>
488+
</div>
489+
</div>
490+
</div>
491+
<div class="sect1">
398492
<h2 id="apidoc-actionchain-addConfigurationDeployment-loggedInUser-chainLabel-sid-revisionSpecifiers"><a class="anchor" href="#apidoc-actionchain-addConfigurationDeployment-loggedInUser-chainLabel-sid-revisionSpecifiers"></a><a class="link" href="#apidoc-actionchain-addConfigurationDeployment-loggedInUser-chainLabel-sid-revisionSpecifiers">Method: addConfigurationDeployment</a></h2>
399493
<div class="sectionbody">
400494
<div class="paragraph">
@@ -1229,7 +1323,7 @@ <h2 id="apidoc-actionchain-scheduleChain-loggedInUser-chainLabel-date"><a class=
12291323
</div>
12301324
</div>
12311325
<nav class="pagination">
1232-
<span class="prev"><a href="faqs.html">FAQ</a></span>
1326+
<span class="prev"><a href="access.html">access</a></span>
12331327
<span class="next"><a href="activationkey.html">activationkey</a></span>
12341328
</nav>
12351329
</article>
@@ -1238,6 +1332,7 @@ <h2 id="apidoc-actionchain-scheduleChain-loggedInUser-chainLabel-date"><a class=
12381332
</div>
12391333
<script src="../../_/js/site.js"></script>
12401334
<script async src="../../_/js/vendor/highlight.js"></script>
1335+
<script async src="../../_/js/vendor/tabs.js"></script>
12411336
<script src="../../_/js/vendor/lunr.js"></script>
12421337
<script src="../../_/js/search-ui.js" id="search-ui-script" data-site-root-path="../.." data-snippet-length="100" data-stylesheet="../../_/css/search.css"></script>
12431338
<script async src="../../search-index.js"></script>

0 commit comments

Comments
 (0)