Files
google-apis-rs/google_container1_cli/projects_zones-clusters-set-master-auth/index.html
2024-03-05 21:06:01 +01:00

444 lines
25 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-container1-cli/projects_zones-clusters-set-master-auth/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Zones Clusters Set Master Auth - Container v5.0.4+20240214</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Zones Clusters Set Master Auth";
var mkdocs_page_input_path = "projects_zones-clusters-set-master-auth.md";
var mkdocs_page_url = "/google-apis-rs/google-container1-cli/projects_zones-clusters-set-master-auth/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Container v5.0.4+20240214
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_aggregated-usable-subnetworks-list/">Aggregated Usable Subnetworks List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-check-autopilot-compatibility/">Locations Clusters Check Autopilot Compatibility</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-complete-ip-rotation/">Locations Clusters Complete Ip Rotation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-create/">Locations Clusters Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-delete/">Locations Clusters Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-get/">Locations Clusters Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-get-jwks/">Locations Clusters Get Jwks</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-list/">Locations Clusters List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-complete-upgrade/">Locations Clusters Node Pools Complete Upgrade</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-create/">Locations Clusters Node Pools Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-delete/">Locations Clusters Node Pools Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-get/">Locations Clusters Node Pools Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-list/">Locations Clusters Node Pools List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-rollback/">Locations Clusters Node Pools Rollback</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-set-autoscaling/">Locations Clusters Node Pools Set Autoscaling</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-set-management/">Locations Clusters Node Pools Set Management</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-set-size/">Locations Clusters Node Pools Set Size</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-update/">Locations Clusters Node Pools Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-addons/">Locations Clusters Set Addons</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-legacy-abac/">Locations Clusters Set Legacy Abac</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-locations/">Locations Clusters Set Locations</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-logging/">Locations Clusters Set Logging</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-maintenance-policy/">Locations Clusters Set Maintenance Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-master-auth/">Locations Clusters Set Master Auth</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-monitoring/">Locations Clusters Set Monitoring</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-network-policy/">Locations Clusters Set Network Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-resource-labels/">Locations Clusters Set Resource Labels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-start-ip-rotation/">Locations Clusters Start Ip Rotation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-update/">Locations Clusters Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-update-master/">Locations Clusters Update Master</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-well-known-get-openid-configuration/">Locations Clusters Well Known Get Openid Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get-server-config/">Locations Get Server Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-list/">Locations Operations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-addons/">Zones Clusters Addons</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-complete-ip-rotation/">Zones Clusters Complete Ip Rotation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-create/">Zones Clusters Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-delete/">Zones Clusters Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-get/">Zones Clusters Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-legacy-abac/">Zones Clusters Legacy Abac</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-list/">Zones Clusters List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-locations/">Zones Clusters Locations</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-logging/">Zones Clusters Logging</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-master/">Zones Clusters Master</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-monitoring/">Zones Clusters Monitoring</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-autoscaling/">Zones Clusters Node Pools Autoscaling</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-create/">Zones Clusters Node Pools Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-delete/">Zones Clusters Node Pools Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-get/">Zones Clusters Node Pools Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-list/">Zones Clusters Node Pools List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-rollback/">Zones Clusters Node Pools Rollback</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-set-management/">Zones Clusters Node Pools Set Management</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-set-size/">Zones Clusters Node Pools Set Size</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-update/">Zones Clusters Node Pools Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-resource-labels/">Zones Clusters Resource Labels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-set-maintenance-policy/">Zones Clusters Set Maintenance Policy</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Zones Clusters Set Master Auth</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-set-network-policy/">Zones Clusters Set Network Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-start-ip-rotation/">Zones Clusters Start Ip Rotation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-update/">Zones Clusters Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-get-serverconfig/">Zones Get Serverconfig</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-operations-cancel/">Zones Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-operations-get/">Zones Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-operations-list/">Zones Operations List</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Container v5.0.4+20240214</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Zones Clusters Set Master Auth</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/container1-cli/edit/master/docs/projects_zones-clusters-set-master-auth.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>container1 --scope &lt;scope&gt; projects zones-clusters-set-master-auth ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;project-id&gt;</strong> <em>(string)</em><ul>
<li>Deprecated. The Google Developers Console <a href="https://cloud.google.com/resource-manager/docs/creating-managing-projects">project ID or project number</a>. This field has been deprecated and replaced by the name field.</li>
</ul>
</li>
<li><strong>&lt;zone&gt;</strong> <em>(string)</em><ul>
<li>Deprecated. The name of the Google Compute Engine <a href="https://cloud.google.com/compute/docs/zones#available">zone</a> in which the cluster resides. This field has been deprecated and replaced by the name field.</li>
</ul>
</li>
<li><strong>&lt;cluster-id&gt;</strong> <em>(string)</em><ul>
<li>Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>SetMasterAuthRequest:
action: string
cluster-id: string
name: string
project-id: string
update:
client-certificate: string
client-certificate-config:
issue-client-certificate: boolean
client-key: string
cluster-ca-certificate: string
password: string
username: string
zone: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . action=ea</code><ul>
<li>Required. The exact form of action to be taken on the master auth.</li>
</ul>
</li>
<li><code>cluster-id=no</code><ul>
<li>Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.</li>
</ul>
</li>
<li><code>name=eirmod</code><ul>
<li>The name (project, location, cluster) of the cluster to set auth. Specified in the format <code>projects/*/locations/*/clusters/*</code>.</li>
</ul>
</li>
<li><code>project-id=no</code><ul>
<li>Deprecated. The Google Developers Console <a href="https://cloud.google.com/resource-manager/docs/creating-managing-projects">project ID or project number</a>. This field has been deprecated and replaced by the name field.</li>
</ul>
</li>
<li><code>update client-certificate=ea</code><ul>
<li>[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.</li>
</ul>
</li>
<li>
<p><code>client-certificate-config issue-client-certificate=true</code></p>
<ul>
<li>Issue a client certificate.</li>
</ul>
</li>
<li>
<p><code>.. client-key=sit</code></p>
<ul>
<li>[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.</li>
</ul>
</li>
<li><code>cluster-ca-certificate=accusam</code><ul>
<li>[Output only] Base64-encoded public certificate that is the root of trust for the cluster.</li>
</ul>
</li>
<li><code>password=eos</code><ul>
<li>The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication</li>
</ul>
</li>
<li>
<p><code>username=ipsum</code></p>
<ul>
<li>The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication</li>
</ul>
</li>
<li>
<p><code>.. zone=sadipscing</code></p>
<ul>
<li>Deprecated. The name of the Google Compute Engine <a href="https://cloud.google.com/compute/docs/zones#available">zone</a> in which the cluster resides. This field has been deprecated and replaced by the name field.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_zones-clusters-set-maintenance-policy/" class="btn btn-neutral float-left" title="Zones Clusters Set Maintenance Policy"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_zones-clusters-set-network-policy/" class="btn btn-neutral float-right" title="Zones Clusters Set Network Policy">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/container1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_zones-clusters-set-maintenance-policy/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_zones-clusters-set-network-policy/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>