22.2. BareMetalHost [metal3.io/v1alpha1]

automatedCleaningMode

string

無効に設定すると、プロビジョニングおよびプロビジョニング解除中に自動クリーニングが回避されます。

bmc

object

BMC に接続するにはどうすればよいですか ?

bootMACAddress

string

PXE はどの MAC アドレスで起動しますか ?これは一部のタイプではオプションですが、vbmc によって駆動される libvirtVM では必須です。

bootMode

string

起動時にハードウェアを初期化する方法を選択します。デフォルトは UEFI です。

consumerRef

object

ConsumerRef は、ホストを使用しているものに関する情報を格納するために使用できます。空でない場合、ホストは使用中と見なされます。

customDeploy

object

カスタムデプロイ手順。

description

string

説明は、ホストを識別するために使用される人間が入力したテキストです

externallyProvisioned

ブール値

ExternallyProvisioned は、他の何かがホスト上で実行されているイメージを管理していることを意味し、Operator は電源ステータスとハードウェアインベントリー検査のみを管理する必要があります。イメージフィールドに入力すると、このフィールドは無視されます。

firmware

object

ベアメタルサーバーの BIOS 設定

hardwareProfile

string

このホストのハードウェアプロファイルの名前は何ですか ?これを設定する必要があるのは、検査でプロファイルを自動的に判別できない場合のみです。

image

object

イメージは、プロビジョニングされるイメージの詳細を保持します。

metaData

object

MetaData は、ホストメタデータを含むシークレットへの参照を保持します (たとえば、Config Drive に渡される meta_data.json)。

networkData

object

NetworkData は、ネットワーク設定を含むシークレットへの参照を保持します (たとえば、設定ドライブに渡される network_data.json のコンテンツ)。

online

ブール値

サーバーはオンラインである必要がありますか ?

raid

object

ベアメタルサーバーの RAID 設定

rootDeviceHints

object

プロビジョニングするイメージのデバイスを選択する方法についてのガイダンスを提供します。

taints

array

汚染は、対応するマシンに適用する汚染の完全で信頼できるリストです。このリストは、継続的にマシンに加えられた変更を上書きします。

taints[]

object

この汚染が接続されているノードは、汚染を許容しない Pod に影響を及ぼします。

userData

object

UserData は、ホストが起動する前にホストに渡されるユーザーデータを含むシークレットへの参照を保持します。

address

string

アドレスは、ネットワーク上のコントローラーにアクセスするための URL を保持します。

credentialsName

string

BMC クレデンシャルを含むシークレットの名前 (キー username および password が必要)。

disableCertificateVerification

ブール値

DisableCertificateVerification は、HTTPS を使用して BMC に接続するときに、サーバー証明書の検証を無効にします。これは、サーバー証明書が自己署名されている場合に必要ですが、中間者が接続を傍受できるため、安全ではありません。

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、spec.containers{name} などの値に設定されます (name はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、spec.containers[2] の値に設定されます (この Pod 内でインデックス が 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。

kind

string

参照先の種類。詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

method

string

カスタムデプロイメソッド名。この名前は、使用されるデプロイ RAM ディスクに固有です。カスタムデプロイ RAM ディスクがない場合は、CustomDeploy を使用しないでください。

simultaneousMultithreadingEnabled

ブール値

単一の物理プロセッサーコアを複数の論理プロセッサーとして表示できるようにします。これは、次のオプションをサポートします:true、false。

sriovEnabled

ブール値

SR-IOV のサポートにより、ハイパーバイザーは PCI-express デバイスの仮想インスタンスを作成することができ、潜在的に性能を向上させることができます。これは、次のオプションをサポートします:true、false。

virtualizationEnabled

ブール値

プラットフォームハードウェアの仮想化をサポートします。これは、次のオプションをサポートします:true、false。

checksum

string

チェックサムは、イメージのチェックサムです。

checksumType

string

ChecksumType は、イメージのチェックサムアルゴリズムです。例:md5、sha256、sha512

format

string

DiskFormat には、イメージのフォーマット (raw、qcow2、…) が含まれています。生のイメージをストリーミングするには、raw に設定する必要があります。live-iso は、URL によって参照される iso がライブブートされ、ディスクにデプロイされないことを意味します。この場合、チェックサムオプションは不要であり、指定されている場合は無視されます。

url

string

URL は、デプロイするイメージの場所です。

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

hardwareRAIDVolumes

``

ハードウェア RAID の論理ディスクのリスト。rootDeviceHints が使用されていない場合、最初のボリュームはルートボリュームです。このフィールドの値を [] に設定して、すべてのハードウェア RAID 設定をクリアできます。

softwareRAIDVolumes

``

ソフトウェア RAID の論理ディスクのリスト。rootDeviceHints が使用されていない場合、最初のボリュームはルートボリュームです。HardwareRAIDVolumes が設定されている場合、この項目は無効になります。作成されるソフトウェア RAID デバイスの数は、1 または 2 である必要があります。ソフトウェア RAID デバイスが 1 つしかない場合は、RAID-1 である必要があります。2 つある場合、最初の 1 つは RAID-1 である必要があり、2 番目の RAID レベルは 0、1、または 1+0 にすることができます。最初の RAID デバイスが展開デバイスになるため、RAID-1 を適用すると、ディスク障害が発生した場合にノードが起動しない状態になるリスクが軽減されます。ソフトウェア RAID は常に削除されます。

deviceName

string

/dev/vda のような Linux デバイス名。ヒントは、実際の値と完全に一致する必要があります。

hctl

string

0:0:0:0 のような SCSI バスアドレス。ヒントは、実際の値と完全に一致する必要があります。

minSizeGigabytes

integer

デバイスの最小サイズ (ギガバイト単位)。

model

string

ベンダー固有のデバイス識別子。ヒントは、実際の値のサブ文字列になります。

rotational

ブール値

デバイスが回転メディアを使用する必要がある場合は true、それ以外の場合は false。

serialNumber

string

デバイスのシリアル番号。ヒントは、実際の値と完全に一致する必要があります。

ベンダー

string

デバイスのベンダーまたはメーカーの名前。ヒントは、実際の値のサブ文字列になります。

wwn

string

一意のストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

wwnVendorExtension

string

一意のベンダーストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

wwnWithExtension

string

ベンダーエクステンションを追加した一意のストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

effect

string

必須。汚染を許容しない Pod に対する汚染の影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

必須。ノードに適用される汚染キー。

timeAdded

string

TimeAdded は、汚染が追加された時刻を表します。NoExecute 汚染のためにのみ書かれています。

value

string

汚染キーに対応する汚染値。

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

errorCount

integer

ErrorCount は、最後に成功した操作以降にホストがエラーを発生させた回数を記録します

errorMessage

string

プロビジョニングサブシステムによって報告された最後のエラーメッセージ

errorType

string

ErrorType は、OperationalStatus が OperationalStatusError のときに発生した障害のタイプを示します

goodCredentials

object

動作していると検証できた最後のクレデンシャル

ハードウェア

object

ホスト上に存在することが検出されたハードウェア。

hardwareProfile

string

ハードウェアの詳細に一致するプロファイルの名前。

lastUpdated

string

LastUpdated は、このステータスが最後に観察された日時を識別します。

operationHistory

object

OperationHistory は、このホストで実行された操作に関する情報を保持します。

operationalStatus

string

OperationalStatus は、ホストのステータスを保持します

poweredOn

ブール値

ホストの電源がオンになっているかどうかのインジケーター

provisioning

object

プロビジョニング担当者が追跡する情報。

triedCredentials

object

プロビジョニングバックエンドに送信した最後のクレデンシャル

credentials

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

credentialsVersion

string

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

cpu

object

CPU は、ホスト上の 1 つのプロセッサーを表します。

firmware

object

ファームウェアは、ホスト上のファームウェアを表します。

hostname

string

nics

array

nics[]

object

NIC は、ホスト上の 1 つのネットワークインターフェイスを記述します。

ramMebibytes

integer

storage

array

storage[]

object

ストレージは、ホスト上の 1 つのストレージデバイス (ディスク、SSD など) を表します。

systemVendor

object

HardwareSystemVendor は、ハードウェアシステム全体に関する詳細を格納します。

arch

string

clockMegahertz

number

ClockSpeed は MHz 単位のクロック速度です

count

integer

flags

array (string)

model

string

bios

object

このファームウェアの BIOS

date

string

この BIOS のリリース/ビルド日

ベンダー

string

この BIOS のベンダー名

version

string

BIOS のバージョン

ip

string

インターフェイスの IP アドレス。存在する場合、これは IPv4 または IPv6 アドレスになります。IPv4 アドレスと IPv6 アドレスの両方がデュアルスタック環境に存在する場合、各 IP に 1 つずつ、合計 2 つの NIC が出力されます。

mac

string

デバイスの MAC アドレス

model

string

NIC のベンダー ID と製品 ID、例:"0x8086 0x1572"

name

string

ネットワークインターフェイスの名前 (例:en0)

pxe

ブール値

NIC が PXE ブータブルかどうか

speedGbps

integer

デバイスの速度 (ギガビット/秒)

vlanId

integer

タグなし VLANID

vlans

array

利用可能な VLAN

vlans[]

object

VLAN は、VLAN の名前と ID を表します

id

integer

VLANID は、12 ビットの 802.1QVLAN 識別子です。

name

string

hctl

string

デバイスの SCSI ロケーション

model

string

ハードウェアモデル

name

string

ディスクの Linux デバイス名 (例:/dev/sda)。これは再起動後も安定しない可能性があることに注意してください。

rotational

ブール値

このディスクが回転ストレージを表すかどうか。このフィールドの使用は推奨されていません。代わりにタイプフィールドを使用することをお勧めします。このフィールドは最終的に非推奨になります。

serialNumber

string

デバイスのシリアル番号

sizeBytes

integer

ディスクのサイズ (バイト単位)

type

string

デバイスタイプ、HDD、SSD、NVME のいずれか。

ベンダー

string

デバイスのベンダーの名前

wwn

string

デバイスの WWN

wwnVendorExtension

string

デバイスの WWN ベンダー拡張

wwnWithExtension

string

拡張子が付いた WWN

manufacturer

string

productName

string

serialNumber

string

deprovision (プロビジョニング解除)

object

OperationMetric には、メトリックの追跡に使用される操作 (検査、プロビジョニングなど) に関するメタデータが含まれています。

inspect

object

OperationMetric には、メトリックの追跡に使用される操作 (検査、プロビジョニングなど) に関するメタデータが含まれています。

provision (プロビジョニング)

object

OperationMetric には、メトリックの追跡に使用される操作 (検査、プロビジョニングなど) に関するメタデータが含まれています。

register

object

OperationMetric には、メトリックの追跡に使用される操作 (検査、プロビジョニングなど) に関するメタデータが含まれています。

end

``

start

``

end

``

start

``

end

``

start

``

end

``

start

``

ID

string

基盤となるプロビジョニングツールからのマシンの UUID

bootMode

string

BootMode は、ノードのプロビジョニングに使用されるブートモードを示します

customDeploy

object

ホストに適用されるカスタムデプロイ手順。

firmware

object

ユーザーが設定した BIOS

image

object

イメージは、ホストに正常にプロビジョニングされた最後のイメージの詳細を保持します。

raid

object

ユーザーが設定したレイド

rootDeviceHints

object

ユーザーが設定した RootDevicehints

state

string

プロビジョニング担当者がホストに対して行っていることの指標。

method

string

カスタムデプロイメソッド名。この名前は、使用されるデプロイ RAM ディスクに固有です。カスタムデプロイ RAM ディスクがない場合は、CustomDeploy を使用しないでください。

simultaneousMultithreadingEnabled

ブール値

単一の物理プロセッサーコアを複数の論理プロセッサーとして表示できるようにします。これは、次のオプションをサポートします:true、false。

sriovEnabled

ブール値

SR-IOV のサポートにより、ハイパーバイザーは PCI-express デバイスの仮想インスタンスを作成することができ、潜在的に性能を向上させることができます。これは、次のオプションをサポートします:true、false。

virtualizationEnabled

ブール値

プラットフォームハードウェアの仮想化をサポートします。これは、次のオプションをサポートします:true、false。

checksum

string

チェックサムは、イメージのチェックサムです。

checksumType

string

ChecksumType は、イメージのチェックサムアルゴリズムです。例:md5、sha256、sha512

format

string

DiskFormat には、イメージのフォーマット (raw、qcow2、…) が含まれています。生のイメージをストリーミングするには、raw に設定する必要があります。live-iso は、URL によって参照される iso がライブブートされ、ディスクにデプロイされないことを意味します。この場合、チェックサムオプションは不要であり、指定されている場合は無視されます。

url

string

URL は、デプロイするイメージの場所です。

hardwareRAIDVolumes

``

ハードウェア RAID の論理ディスクのリスト。rootDeviceHints が使用されていない場合、最初のボリュームはルートボリュームです。このフィールドの値を [] に設定して、すべてのハードウェア RAID 設定をクリアできます。

softwareRAIDVolumes

``

ソフトウェア RAID の論理ディスクのリスト。rootDeviceHints が使用されていない場合、最初のボリュームはルートボリュームです。HardwareRAIDVolumes が設定されている場合、この項目は無効になります。作成されるソフトウェア RAID デバイスの数は、1 または 2 である必要があります。ソフトウェア RAID デバイスが 1 つしかない場合は、RAID-1 である必要があります。2 つある場合、最初の 1 つは RAID-1 である必要があり、2 番目の RAID レベルは 0、1、または 1+0 にすることができます。最初の RAID デバイスが展開デバイスになるため、RAID-1 を適用すると、ディスク障害が発生した場合にノードが起動しない状態になるリスクが軽減されます。ソフトウェア RAID は常に削除されます。

deviceName

string

/dev/vda のような Linux デバイス名。ヒントは、実際の値と完全に一致する必要があります。

hctl

string

0:0:0:0 のような SCSI バスアドレス。ヒントは、実際の値と完全に一致する必要があります。

minSizeGigabytes

integer

デバイスの最小サイズ (ギガバイト単位)。

model

string

ベンダー固有のデバイス識別子。ヒントは、実際の値のサブ文字列になります。

rotational

ブール値

デバイスが回転メディアを使用する必要がある場合は true、それ以外の場合は false。

serialNumber

string

デバイスのシリアル番号。ヒントは、実際の値と完全に一致する必要があります。

ベンダー

string

デバイスのベンダーまたはメーカーの名前。ヒントは、実際の値のサブ文字列になります。

wwn

string

一意のストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

wwnVendorExtension

string

一意のベンダーストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

wwnWithExtension

string

ベンダーエクステンションを追加した一意のストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

credentials

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

credentialsVersion

string

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

200 - OK

BareMetalHostList schema

401 - Unauthorized

空白

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

pretty

string

'true' の場合、出力はきれいに印刷されます。

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

200 - OK

Status_v2 schema

401 - Unauthorized

空白

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

200 - OK

BareMetalHostList schema

401 - Unauthorized

空白

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

ボディー

BareMetalHost schema

200 - OK

BareMetalHost schema

201 - Created

BareMetalHost schema

202 - Accepted

BareMetalHost schema

401 - Unauthorized

空白

name

string

BareMetalHost の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

pretty

string

'true' の場合、出力はきれいに印刷されます。

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。

body

DeleteOptions_v2 schema

200 - OK

Status_v2 schema

202 - Accepted

Status_v2 schema

401 - Unauthorized

空白

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

200 - OK

BareMetalHost schema

401 - Unauthorized

空白

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

body

Patch schema

200 - OK

BareMetalHost schema

401 - Unauthorized

空白

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

ボディー

BareMetalHost schema

200 - OK

BareMetalHost schema

201 - Created

BareMetalHost schema

401 - Unauthorized

空白

name

string

BareMetalHost の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

200 - OK

BareMetalHost schema

401 - Unauthorized

空白

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

body

Patch schema

200 - OK

BareMetalHost schema

401 - Unauthorized

空白

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

ボディー

BareMetalHost schema

200 - OK

BareMetalHost schema

201 - Created

BareMetalHost schema

401 - Unauthorized

空白