[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10},"actionData","errors","root",{"_4157":4158,"_4159":4160,"_4161":4162,"_4163":4164},"routes/cli",{"_27":28,"_29":30,"_31":32,"_33":34},"routes/cli.$",{"_11":12},"cmd",{"_13":14,"_15":16,"_17":18,"_19":14},"name","ping","about","

Ping API

Always responds with Ok if it responds at all.

\n","args",[20],"slug",{"_21":22,"_23":24,"_25":26},"long","profile","help","Configuration profile to use for commands","global",true,"subcommands",[49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,12,68,69,70,71,72,73,74,75,76,77,78],"guides",[41,42],"version","0.17.0+2026060800.0.0","specSource",{"_35":36,"_37":38,"_39":40},"tag","96ac7bd9d02f4b0b0f15f899d768c5d2f0dd19c3","jsonUrl","https://github.com/oxidecomputer/oxide.rs/blob/96ac7bd9d02f4b0b0f15f899d768c5d2f0dd19c3/cli/docs/cli.json","repoUrl","https://github.com/oxidecomputer/oxide.rs/tree/96ac7bd9d02f4b0b0f15f899d768c5d2f0dd19c3",{"_43":47,"_45":48},{"_43":44,"_45":46},"path","/guides/quickstart-cli","title","Quick Start: CLI","/cli/guides/introduction","Introduction",{"_13":3992,"_17":3993,"_27":3994,"_19":3992},{"_13":3959,"_15":3960,"_1000":3961,"_17":3962,"_19":3959},{"_13":3941,"_17":3942,"_27":3943,"_19":3941},{"_13":1486,"_15":3896,"_1000":3897,"_17":3898,"_27":3899,"_19":1486},{"_13":3877,"_17":3878,"_27":3879,"_19":3877},{"_13":3803,"_17":3804,"_27":3805,"_19":3803},{"_13":3758,"_17":3759,"_27":3760,"_19":3758},{"_13":3743,"_15":3744,"_1000":3745,"_17":3746,"_19":3743},{"_13":3666,"_17":3667,"_27":3668,"_19":3666},{"_13":1921,"_17":3551,"_27":3552,"_19":1921},{"_13":3542,"_15":3543,"_17":3544,"_19":3542},{"_13":3267,"_17":3268,"_27":3269,"_19":3267},{"_13":2850,"_17":3201,"_27":3202,"_19":2850},{"_13":3130,"_17":3131,"_27":3132,"_19":3130},{"_13":432,"_17":3119,"_27":3120,"_19":432},{"_13":2842,"_17":3061,"_27":3062,"_19":2842},{"_13":2579,"_17":2580,"_27":2581,"_19":2579},{"_13":2447,"_17":2448,"_27":2449,"_19":2447},{"_13":1058,"_17":2428,"_27":2429,"_19":1058},{"_13":543,"_17":2413,"_27":2414,"_19":543},{"_13":98,"_17":2352,"_27":2353,"_19":98},{"_13":2315,"_17":2316,"_27":2317,"_19":2315},{"_13":656,"_17":2038,"_27":2039,"_19":656},{"_13":1998,"_17":1999,"_27":2000,"_19":1998},{"_13":623,"_17":1983,"_27":1984,"_19":623},{"_13":434,"_17":435,"_27":436,"_19":434},{"_13":385,"_17":386,"_27":387,"_19":385},{"_13":381,"_15":382,"_17":383,"_19":381},{"_13":31,"_15":378,"_17":379,"_19":31},{"_13":79,"_17":80,"_27":81,"_19":79},"vpc",[377],[82,83,84,85,86,87,88,89],{"_13":192,"_15":364,"_17":365,"_19":366},{"_13":184,"_15":358,"_17":359,"_19":360},{"_13":337,"_17":338,"_27":339,"_19":340},{"_13":156,"_15":329,"_17":330,"_19":331},{"_13":212,"_17":213,"_27":214,"_19":215},{"_13":118,"_17":119,"_27":120,"_19":121},{"_13":100,"_15":101,"_17":102,"_19":103},{"_13":90,"_15":91,"_17":92,"_19":93},"view","

Fetch VPC

\n",[94,95,96],"vpc/view",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":79,"_23":97},"Name or ID of the VPC","project","Name or ID of the project","update","

Update VPC

\n",[104,105,106,107,108,109,110,111],"vpc/update",{"_21":117},{"_21":116},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":79,"_23":97},"json-body-template","XXX","json-body","Path to a file that contains the full json body.","dns-name","description","subnet",[211],[122,123,124,125,126,127],"vpc/subnet",{"_13":192,"_15":193,"_17":194,"_19":195},{"_13":184,"_15":185,"_17":186,"_19":187},{"_13":156,"_15":175,"_17":176,"_19":177},{"_13":151,"_17":152,"_27":153,"_19":154},{"_13":100,"_15":137,"_17":138,"_19":139},{"_13":90,"_15":128,"_17":129,"_19":130},"

Fetch subnet

\n",[131,132,133,134],"vpc/subnet/view",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":118,"_23":135},{"_21":79,"_23":97},"Name or ID of the subnet","Name or ID of the project, only required if `vpc` is provided as a `Name`","

Update subnet

\n",[140,141,142,143,144,145,146,147,148],"vpc/subnet/update",{"_21":149,"_23":150},{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":118,"_23":135},{"_21":79,"_23":97},"custom-router","An optional router, used to direct packets sent from hosts in this subnet to any destination address.","nic",[174],[155],"vpc/subnet/nic",{"_13":156,"_15":157,"_17":158,"_19":159},"list","

List network interfaces

\n",[160,161,162,163,164,165],"vpc/subnet/nic/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":166,"_167":168},{"_21":118,"_23":135},{"_21":79,"_23":97},"sort-by","values",[169,170,171],"name_ascending","name_descending","id_ascending","limit","Maximum number of items returned by a single call",{"_21":22,"_23":24,"_25":26},"

List subnets

\n",[178,179,180,181,182],"vpc/subnet/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":166,"_167":183},{"_21":79,"_23":97},[169,170,171],"delete","

Delete subnet

\n",[188,189,190,191],"vpc/subnet/delete",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":118,"_23":135},{"_21":79,"_23":97},"create","

Create subnet

\n",[196,197,198,199,200,201,202,203,204,205],"vpc/subnet/create",{"_21":149,"_23":210},{"_21":117},{"_21":208,"_23":209},{"_21":206,"_23":207},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":97},"ipv6-block","The IPv6 address range for this subnet.\n\nIt must be allocated from the RFC 4193 Unique Local Address range, with the prefix equal to the parent VPC's prefix. A random `/64` block will be assigned if one is not provided. It must not overlap with any existing subnet in the VPC.","ipv4-block","The IPv4 address range for this subnet.\n\nIt must be allocated from an RFC 1918 private address range, and must not overlap with any other existing subnet in the VPC.","An optional router, used to direct packets sent from hosts in this subnet to any destination address.\n\nCustom routers apply in addition to the VPC-wide *system* router, and have higher priority than the system router for an otherwise equal-prefix-length match.",{"_21":22,"_23":24,"_25":26},"router",[328],[216,217,218,219,220,221],"vpc/router",{"_13":192,"_15":318,"_17":319,"_19":320},{"_13":184,"_15":311,"_17":312,"_19":313},{"_13":156,"_15":302,"_17":303,"_19":304},{"_13":241,"_17":242,"_27":243,"_19":244},{"_13":100,"_15":230,"_17":231,"_19":232},{"_13":90,"_15":222,"_17":223,"_19":224},"

Fetch router

\n",[225,226,227,228],"vpc/router/view",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":212,"_23":229},{"_21":79,"_23":97},"Name or ID of the router","

Update router

\n",[233,234,235,236,237,238,239,240],"vpc/router/update",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":212,"_23":229},{"_21":79,"_23":97},"route",[301],[245,246,247,248,249],"vpc/router/route",{"_13":192,"_15":290,"_17":291,"_19":292},{"_13":184,"_15":282,"_17":283,"_19":284},{"_13":156,"_15":272,"_17":273,"_19":274},{"_13":100,"_15":260,"_17":261,"_19":262},{"_13":90,"_15":250,"_17":251,"_19":252},"

Fetch route

\n",[253,254,255,256,257],"vpc/router/route/view",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":241,"_23":259},{"_21":212,"_23":229},{"_21":79,"_23":258},"Name or ID of the VPC, only required if `router` is provided as a `Name`","Name or ID of the route","

Update route

\n",[263,264,265,266,267,268,269,270,271],"vpc/router/route/update",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":241,"_23":259},{"_21":212,"_23":229},{"_21":79,"_23":258},"

List routes

List the routes associated with a router in a particular VPC.

\n",[275,276,277,278,279,280],"vpc/router/route/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":212,"_23":229},{"_21":166,"_167":281},{"_21":79,"_23":258},[169,170,171],"

Delete route

\n",[285,286,287,288,289],"vpc/router/route/delete",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":241,"_23":259},{"_21":212,"_23":229},{"_21":79,"_23":258},"

Create route

\n",[293,294,295,296,297,298,299,300],"vpc/router/route/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":212,"_23":229},{"_21":79,"_23":258},{"_21":22,"_23":24,"_25":26},"

List routers

\n",[305,306,307,308,309],"vpc/router/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":166,"_167":310},{"_21":79,"_23":97},[169,170,171],"

Delete router

\n",[314,315,316,317],"vpc/router/delete",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":212,"_23":229},{"_21":79,"_23":97},"

Create VPC router

\n",[321,322,323,324,325,326,327],"vpc/router/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":97},{"_21":22,"_23":24,"_25":26},"

List VPCs

\n",[332,333,334,335],"vpc/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":336},[169,170,171],"firewall-rules",[357],[341,342],"vpc/firewall-rules",{"_13":100,"_15":349,"_17":350,"_19":351},{"_13":90,"_15":343,"_17":344,"_19":345},"

List firewall rules

\n",[346,347,348],"vpc/firewall-rules/view",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":97},"

Replace firewall rules

The maximum number of rules per VPC is 1024.

Targets are used to specify the set of instances to which a firewall rule applies. You can target instances directly by name, or specify a VPC, VPC subnet, IP, or IP subnet, which will apply the rule to traffic going to all matching instances. Targets are additive: the rule applies to instances matching ANY target. The maximum number of targets is 256.

Filters reduce the scope of a firewall rule. Without filters, the rule applies to all packets to the targets (or from the targets, if it's an outbound rule). With multiple filters, the rule applies only to packets matching ALL filters. The maximum number of each type of filter is 256.

\n",[352,353,354,355,356],"vpc/firewall-rules/update",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":97},{"_21":22,"_23":24,"_25":26},"

Delete VPC

\n",[361,362,363],"vpc/delete",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":79,"_23":97},"

Create VPC

\n",[367,368,369,370,371,372,373,374],"vpc/create",{"_21":117},{"_21":116},{"_21":375,"_23":376},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"ipv6-prefix","The IPv6 prefix for this VPC\n\nAll IPv6 subnets created from this VPC must be taken from this range, which should be a Unique Local Address in the range `fd00::/48`. The default VPC Subnet will have the first `/64` range from this prefix.",{"_21":22,"_23":24,"_25":26},"

Prints version information about the CLI.

\n",[380],{"_21":22,"_23":24,"_25":26},"utilization","

Fetch resource utilization for user's current silo

\n",[384],{"_21":22,"_23":24,"_25":26},"user",[433],[388,389,390,391,392],{"_13":156,"_15":424,"_17":425,"_19":426},{"_13":415,"_15":416,"_17":417,"_19":418},{"_13":406,"_15":407,"_17":408,"_19":409},{"_13":400,"_15":401,"_17":402,"_19":403},{"_13":90,"_15":393,"_17":394,"_19":395},"

Fetch user

\n",[396,397],"user/view",{"_21":22,"_23":24,"_25":26},{"_21":398,"_23":399},"user-id","ID of the user","logout","

Log user out

Silo admins can use this endpoint to log the specified user out by deleting all of their tokens AND sessions. This cannot be undone.

\n",[404,405],"user/logout",{"_21":22,"_23":24,"_25":26},{"_21":398,"_23":399},"list-tokens","

List user's access tokens

\n",[410,411,412,413],"user/list-tokens",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":414},{"_21":398,"_23":399},[171],"list-sessions","

List user's console sessions

\n",[419,420,421,422],"user/list-sessions",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":423},{"_21":398,"_23":399},[171],"

List users

\n",[427,428,429,430],"user/list",{"_21":432},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":431},[171],"group",{"_21":22,"_23":24,"_25":26},"system",[1982],[437,438,439,440],{"_13":1728,"_17":1729,"_27":1730,"_19":1731},{"_13":560,"_17":561,"_27":562,"_19":563},{"_13":543,"_17":544,"_27":545,"_19":546},{"_13":100,"_17":441,"_27":442,"_19":443},[542],[444,445,446,447,448],"system/update",{"_13":534,"_15":535,"_17":536,"_19":537},{"_13":503,"_17":504,"_27":505,"_19":506},{"_13":498,"_15":499,"_17":500,"_19":501},{"_13":483,"_17":484,"_27":485,"_19":486},{"_13":449,"_17":450,"_27":451,"_19":452},"trust-root",[482],[453,454,455,456],"system/update/trust-root",{"_13":192,"_15":476,"_17":477,"_19":478},{"_13":184,"_15":471,"_17":472,"_19":473},{"_13":156,"_15":464,"_17":465,"_19":466},{"_13":90,"_15":457,"_17":458,"_19":459},"

Fetch trusted root role

\n",[460,461],"system/update/trust-root/view",{"_21":22,"_23":24,"_25":26},{"_21":462,"_23":463},"trust-root-id","ID of the trust root","

List root roles in the updates trust store

A root role is a JSON document describing the cryptographic keys that are trusted to sign system release repositories, as described by The Update Framework. Uploading a repository requires its metadata to be signed by keys trusted by the trust store.

\n",[467,468,469],"system/update/trust-root/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":470},[171],"

Delete trusted root role

Note that this method does not currently check for any uploaded system release repositories that would become untrusted after deleting the root role.

\n",[474,475],"system/update/trust-root/delete",{"_21":22,"_23":24,"_25":26},{"_21":462,"_23":463},"

Add trusted root role to updates trust store

\n",[479,480,481],"system/update/trust-root/create",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"target-release",[497],[487],"system/update/target-release",{"_13":100,"_15":488,"_17":489,"_19":490},"

Set target release

Set the current target release of the rack's system software. The rack reconfigurator will treat the software specified here as a goal state for the rack's software, and attempt to asynchronously update to that release. Use the update status endpoint to view the current target release.

\n",[491,492,493,494],"system/update/target-release/update",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":495,"_23":496},"system-version","Version of the system software to make the target release.",{"_21":22,"_23":24,"_25":26},"status","

Fetch system update status

Returns information about the current target release and the progress of system software updates.

\n",[502],"system/update/status",{"_21":22,"_23":24,"_25":26},"repo",[533],[507,508,509],"system/update/repo",{"_13":156,"_15":524,"_17":525,"_19":526},{"_13":516,"_17":517,"_19":518},{"_13":90,"_15":510,"_17":511,"_19":512},"

Fetch system release repository by version

\n",[513,514],"system/update/repo/view",{"_21":22,"_23":24,"_25":26},{"_21":495,"_23":515},"The version to get.","upload",[519,520],"system/update/repo/upload",{"_521":522,"_21":43,"_23":523},{"_21":22,"_23":24,"_25":26},"short","p","Path to the TUF repository","

List all TUF repositories

Returns a paginated list of all TUF repositories ordered by system version (newest first by default).

\n",[527,528,529],"system/update/repo/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":530},[531,532],"version_ascending","version_descending",{"_21":22,"_23":24,"_25":26},"recovery-finish","

Clear system recovery status

Instructs the system that a system recovery operation ("mupdate") was completed using the software in the specified release.

The system recovery operation is used to bypass the control plane to deploy known-working software when the control plane itself is not functioning or otherwise unable to update itself. When the control plane detects this, it stops making any changes to deployed software to avoid reverting the recovery itself. This operation puts the control plane back in charge of determining what software should be deployed, instructing it that the specified software (which is also what's currently running) is what's supposed to be deployed.

If the provided version does not match what's currently running, the control plane will continue to avoid changing deployed software until this operation is invoked with the correct version.

This endpoint should only be called at the direction of Oxide support.

\n",[538,539,540,541],"system/update/recovery-finish",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":495,"_23":496},{"_21":22,"_23":24,"_25":26},"policy",[559],[547,548],"system/policy",{"_13":100,"_15":553,"_17":554,"_19":555},{"_13":90,"_15":549,"_17":550,"_19":551},"

Fetch top-level IAM policy

\n",[552],"system/policy/view",{"_21":22,"_23":24,"_25":26},"

Update top-level IAM policy

\n",[556,557,558],"system/policy/update",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"networking",[1727],[564,565,566,567,568,569,570,571,572,573,574,575,576,577],"system/networking",{"_13":1368,"_15":1686,"_17":1687,"_27":1688,"_19":1689},{"_13":929,"_17":1632,"_27":1633,"_19":1634},{"_13":1611,"_17":1612,"_27":1613,"_19":1614},{"_13":1559,"_17":1560,"_27":1561,"_19":1562},{"_13":1241,"_17":1242,"_27":1243,"_19":1244},{"_13":1221,"_17":1222,"_27":1223,"_19":1224},{"_13":1058,"_17":1059,"_27":1060,"_19":1061},{"_13":694,"_15":999,"_1000":1001,"_17":1002,"_27":1003,"_19":1004},{"_13":933,"_17":934,"_27":935,"_19":936},{"_13":879,"_17":880,"_27":881,"_19":882},{"_13":241,"_15":796,"_17":797,"_27":798,"_19":799},{"_13":775,"_17":776,"_27":777,"_19":778},{"_13":623,"_17":624,"_27":625,"_19":626},{"_13":578,"_17":579,"_27":580,"_19":581},"switch-port-settings",[622],[582,583,584,585,586],"system/networking/switch-port-settings",{"_13":192,"_15":614,"_17":615,"_19":616},{"_13":184,"_15":609,"_17":610,"_19":611},{"_13":156,"_15":599,"_17":600,"_19":601},{"_13":594,"_15":595,"_17":596,"_19":597},{"_13":90,"_15":587,"_17":588,"_19":589},"

Get information about switch port

\n",[590,591],"system/networking/switch-port-settings/view",{"_21":592,"_23":593},{"_21":22,"_23":24,"_25":26},"port","A name or id to use when selecting switch port settings info objects.","show","

Get the configuration of switch ports.

\n",[598],"system/networking/switch-port-settings/show",{"_21":22,"_23":24,"_25":26},"

List switch port settings

\n",[602,603,604,605],"system/networking/switch-port-settings/list",{"_21":172,"_23":173},{"_21":607,"_23":608},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":606},[169,170,171],"port-settings","An optional name or id to use when selecting port settings.","

Delete switch port settings

\n",[612,613],"system/networking/switch-port-settings/delete",{"_21":607,"_23":608},{"_21":22,"_23":24,"_25":26},"

Create switch port settings

\n",[617,618,619,620,621],"system/networking/switch-port-settings/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"subnet-pool",[774],[627,628,629,630,631,632,633,634],"system/networking/subnet-pool",{"_13":192,"_15":760,"_17":761,"_19":762},{"_13":184,"_15":755,"_17":756,"_19":757},{"_13":156,"_15":748,"_17":749,"_19":750},{"_13":708,"_17":709,"_27":710,"_19":711},{"_13":656,"_17":657,"_27":658,"_19":659},{"_13":100,"_15":647,"_17":648,"_19":649},{"_13":381,"_15":642,"_17":643,"_19":644},{"_13":90,"_15":635,"_17":636,"_19":637},"

Fetch subnet pool

\n",[638,639],"system/networking/subnet-pool/view",{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},"pool","Name or ID of the subnet pool","

Fetch subnet pool utilization

\n",[645,646],"system/networking/subnet-pool/utilization",{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},"

Update subnet pool

\n",[650,651,652,653,654,655],"system/networking/subnet-pool/update",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},"silo",[707],[660,661,662,663],"system/networking/subnet-pool/silo",{"_13":694,"_15":695,"_17":696,"_19":697},{"_13":156,"_15":686,"_17":687,"_19":688},{"_13":679,"_15":680,"_17":681,"_19":682},{"_13":100,"_15":664,"_17":665,"_19":666},"

Update subnet pool's link to silo

\n",[667,668,669,670,671,672],"system/networking/subnet-pool/silo/update",{"_21":674,"_23":675,"_167":676},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},"Name or ID of the silo","is-default","Whether this is the default subnet pool for the silo",[677,678],"true","false","unlink","

Unlink subnet pool from silo

\n",[683,684,685],"system/networking/subnet-pool/silo/unlink",{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},"

List silos linked to subnet pool

\n",[689,690,691,692],"system/networking/subnet-pool/silo/list",{"_21":172,"_23":173},{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":693},[171],"link","

Link subnet pool to silo

\n",[698,699,700,701,702,703],"system/networking/subnet-pool/silo/link",{"_21":674,"_23":705,"_167":706},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":704},"The silo to link","Whether this is the default subnet pool for the silo. When true, external subnet allocations that don't specify a pool use this one.",[677,678],{"_21":22,"_23":24,"_25":26},"member",[747],[712,713,714],"system/networking/subnet-pool/member",{"_13":731,"_15":732,"_17":733,"_19":734},{"_13":156,"_15":725,"_17":726,"_19":727},{"_13":715,"_15":716,"_17":717,"_19":718},"remove","

Remove member from subnet pool

\n",[719,720,721,722,723],"system/networking/subnet-pool/member/remove",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},{"_21":118,"_23":724},"The subnet to remove from the pool. Must match an existing entry exactly.","

List members in subnet pool

\n",[728,729,730],"system/networking/subnet-pool/member/list",{"_21":172,"_23":173},{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},"add","

Add member to subnet pool

\n",[735,736,737,738,739,740,741],"system/networking/subnet-pool/member/add",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":745,"_23":746},{"_21":743,"_23":744},{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},{"_21":118,"_23":742},"The subnet to add to the pool","min-prefix-length","Minimum prefix length for allocations from this subnet; a smaller prefix means larger allocations are allowed (e.g. a /16 prefix yields larger subnet allocations than a /24 prefix).\n\nValid values: 0-32 for IPv4, 0-128 for IPv6. Default if not specified is equal to the subnet's prefix length.","max-prefix-length","Maximum prefix length for allocations from this subnet; a larger prefix means smaller allocations are allowed (e.g. a /24 prefix yields smaller subnet allocations than a /16 prefix).\n\nValid values: 0-32 for IPv4, 0-128 for IPv6. Default if not specified is 32 for IPv4 and 128 for IPv6.",{"_21":22,"_23":24,"_25":26},"

List subnet pools

\n",[751,752,753],"system/networking/subnet-pool/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":754},[169,170,171],"

Delete subnet pool

\n",[758,759],"system/networking/subnet-pool/delete",{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},"

Create subnet pool

\n",[763,764,765,766,767,768],"system/networking/subnet-pool/create",{"_21":117},{"_21":769,"_23":770,"_167":771},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},"ip-version","The IP version for this pool (IPv4 or IPv6). All subnets in the pool must match this version.",[772,773],"v4","v6",{"_21":22,"_23":24,"_25":26},"settings",[795],[779,780],"system/networking/settings",{"_13":100,"_15":785,"_17":786,"_19":787},{"_13":90,"_15":781,"_17":782,"_19":783},"

Fetch fleet-wide networking settings

\n",[784],"system/networking/settings/view",{"_21":22,"_23":24,"_25":26},"

Update fleet-wide networking settings

\n",[788,789,790,791],"system/networking/settings/update",{"_21":792,"_23":793,"_167":794},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},"external-jumbo-frames-opt-in-enabled","Toggle the fleet-wide external jumbo-frames opt-in.",[677,678],{"_21":22,"_23":24,"_25":26},"

Manage static switch routes.

\n",[878],[800,801],"system/networking/route",{"_13":184,"_15":863,"_17":864,"_19":865},{"_13":802,"_15":803,"_17":804,"_19":805},"set","

Set a static route

\n",[806,807,808,809,810,811,812,813],"system/networking/route/set",{"_21":861,"_23":862},{"_21":859,"_23":860},{"_21":592,"_23":825,"_167":826},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":824},{"_21":821,"_23":822},{"_21":816,"_23":817,"_167":818},{"_21":814,"_23":815},"vlan-id","The route vlan id","switch","Switch to configure the route on",[819,820],"switch0","switch1","rib-priority","RIB Priority indicating priority within and across protocols","rack","Id of the rack to configure the route on","Port to configure the route on",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"qsfp0","qsfp1","qsfp2","qsfp3","qsfp4","qsfp5","qsfp6","qsfp7","qsfp8","qsfp9","qsfp10","qsfp11","qsfp12","qsfp13","qsfp14","qsfp15","qsfp16","qsfp17","qsfp18","qsfp19","qsfp20","qsfp21","qsfp22","qsfp23","qsfp24","qsfp25","qsfp26","qsfp27","qsfp28","qsfp29","qsfp30","qsfp31","nexthop","The route nexthop","destination","The route destination","

Delete a static route

\n",[866,867,868,869,870,871,872],"system/networking/route/delete",{"_21":861,"_23":862},{"_21":859,"_23":860},{"_21":592,"_23":876,"_167":877},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":875},{"_21":816,"_23":873,"_167":874},{"_21":814,"_23":815},"Switch to remove the route from",[819,820],"Id of the rack to remove the route from","Port to remove the route from",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],{"_21":22,"_23":24,"_25":26},"loopback-address",[932],[883,884,885],"system/networking/loopback-address",{"_13":192,"_15":909,"_17":910,"_19":911},{"_13":184,"_15":893,"_17":894,"_19":895},{"_13":156,"_15":886,"_17":887,"_19":888},"

List loopback addresses

\n",[889,890,891],"system/networking/loopback-address/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":892},[171],"

Delete loopback address

\n",[896,897,898,899,900],"system/networking/loopback-address/delete",{"_21":908,"_23":905},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":907},{"_21":904,"_23":905},{"_21":901,"_23":902,"_167":903},"switch-slot","The slot of the switch within the rack to use when selecting the loopback address.",[819,820],"subnet-mask","The IP address and subnet mask to use when selecting the loopback address.","rack-id","The rack to use when selecting the loopback address.","address","

Create loopback address

\n",[912,913,914,915,916,917,918,919,920],"system/networking/loopback-address/create",{"_21":908,"_23":931},{"_21":929,"_23":930},{"_21":926,"_23":927,"_167":928},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":924,"_23":925},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":923},{"_21":901,"_23":921,"_167":922},"The slot of the switch within the rack this loopback address will be configured on.",[819,820],"The rack containing the switch this loopback address will be configured on.","mask","The subnet mask to use for the address.","anycast","Address is an anycast address.\n\nThis allows the address to be assigned to multiple locations simultaneously.",[677,678],"address-lot","The name or id of the address lot this loopback address will pull an address from.","The address to create.",{"_21":22,"_23":24,"_25":26},"lldp",[998],[937,938,939],"system/networking/lldp",{"_13":986,"_15":987,"_17":988,"_19":989},{"_13":100,"_15":951,"_17":952,"_19":953},{"_13":90,"_15":940,"_17":941,"_19":942},"

Fetch LLDP configuration for switch port

\n",[943,944,945,946],"system/networking/lldp/view",{"_21":592,"_23":950},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":949},{"_21":901,"_23":947,"_167":948},"The slot of the switch within the rack to use when selecting switch ports.",[819,820],"A rack id to use when selecting switch ports.","A name to use when selecting switch ports.","

Update LLDP configuration for switch port

\n",[954,955,956,957,958,959,960,961,962,963,964,965,966,967],"system/networking/lldp/update",{"_21":984,"_23":985},{"_21":981,"_23":982,"_167":983},{"_21":979,"_23":980},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":977,"_23":978},{"_21":975,"_23":976},{"_21":973,"_23":974},{"_21":592,"_23":950},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":949},{"_21":901,"_23":947,"_167":972},{"_21":970,"_23":971},{"_21":968,"_23":969},"system-name","The LLDP system name TLV.","system-description","The LLDP system description TLV.",[819,820],"management-ip","The LLDP management IP TLV.","link-name","The LLDP link name TLV.","link-description","The LLDP link description TLV.","id","The id of this LLDP service instance.","enabled","Whether or not the LLDP service is enabled.",[677,678],"chassis-id","The LLDP chassis identifier TLV.","neighbors","

Fetch LLDP neighbors for switch port

\n",[990,991,992,993,994,995],"system/networking/lldp/neighbors",{"_21":172,"_23":173},{"_21":592,"_23":950},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":949},{"_21":166,"_167":997},{"_21":901,"_23":947,"_167":996},[819,820],[171],{"_21":22,"_23":24,"_25":26},"

Manage switch port links.

\n","long_about","

Manage switch port links.

Links carry layer-2 Ethernet properties for a lane or set of lanes on a\nswitch port. Lane geometry is defined in physical port settings. At the\npresent time only single lane configurations are supported, and thus only\na single link per physical port is supported.

\n",[1057],[1005,1006],"system/networking/link",{"_13":731,"_15":1019,"_17":1020,"_19":1021},{"_13":184,"_15":1007,"_17":1008,"_19":1009},"

Remove a link from a port

\n",[1010,1011,1012,1013],"system/networking/link/delete",{"_21":592,"_23":1017,"_167":1018},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1016},{"_21":816,"_23":1014,"_167":1015},"Switch to remove the link from",[819,820],"Id of the rack to remove the link from","Port to remove the link from",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"

Add a link to a port

\n",[1022,1023,1024,1025,1026,1027,1028,1029],"system/networking/link/add",{"_21":1055,"_23":1056},{"_21":1049,"_23":1050,"_167":1051},{"_21":1047,"_23":1048},{"_21":592,"_23":1045,"_167":1046},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1044},{"_21":1032,"_23":1033,"_167":1034},{"_21":816,"_23":1030,"_167":1031},"Switch to add the link to",[819,820],"speed","The speed of the link",[1035,1036,1037,1038,1039,1040,1041,1042,1043],"0g","1g","10g","25g","40g","50g","100g","200g","400g","Id of the rack to add the link to","Port to add the link to",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"mtu","Maximum transmission unit for the link","fec","The forward error correction mode of the link",[1052,1053,1054],"firecode","none","rs","autoneg","Whether or not to set auto-negotiation",{"_21":22,"_23":24,"_25":26},"ip-pool",[1220],[1062,1063,1064,1065,1066,1067,1068,1069,1070],"system/networking/ip-pool",{"_13":1210,"_15":1211,"_17":1212,"_19":1213},{"_13":192,"_15":1193,"_17":1194,"_19":1195},{"_13":184,"_15":1188,"_17":1189,"_19":1190},{"_13":156,"_15":1169,"_17":1170,"_19":1171},{"_13":1135,"_17":1136,"_27":1137,"_19":1138},{"_13":656,"_17":1091,"_27":1092,"_19":1093},{"_13":100,"_15":1082,"_17":1083,"_19":1084},{"_13":381,"_15":1077,"_17":1078,"_19":1079},{"_13":90,"_15":1071,"_17":1072,"_19":1073},"

Fetch IP pool

\n",[1074,1075],"system/networking/ip-pool/view",{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},"Name or ID of the IP pool","

Fetch IP pool utilization

\n",[1080,1081],"system/networking/ip-pool/utilization",{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},"

Update IP pool

\n",[1085,1086,1087,1088,1089,1090],"system/networking/ip-pool/update",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},[1134],[1094,1095,1096,1097],"system/networking/ip-pool/silo",{"_13":694,"_15":1123,"_17":1124,"_19":1125},{"_13":156,"_15":1115,"_17":1116,"_19":1117},{"_13":679,"_15":1109,"_17":1110,"_19":1111},{"_13":100,"_15":1098,"_17":1099,"_19":1100},"

Make IP pool default for silo

When a user asks for an IP (e.g., at instance create time) without specifying a pool, the IP comes from the default pool if a default is configured. When a pool is made the default for a silo, any existing default will remain linked to the silo, but will no longer be the default.

\n",[1101,1102,1103,1104,1105,1106],"system/networking/ip-pool/silo/update",{"_21":674,"_23":1107,"_167":1108},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":640},{"_21":22,"_23":24,"_25":26},{"_21":656},"When a pool is the default for a silo, floating IPs and instance ephemeral IPs will come from that pool when no other pool is specified.\n\nA silo can have at most one default pool per combination of pool type (unicast or multicast) and IP version (IPv4 or IPv6), allowing up to 4 default pools total. When a pool is made default, an existing default of the same type and version will remain linked but will no longer be the default.",[677,678],"

Unlink IP pool from silo

Will fail if there are any outstanding IPs allocated in the silo.

\n",[1112,1113,1114],"system/networking/ip-pool/silo/unlink",{"_21":640},{"_21":22,"_23":24,"_25":26},{"_21":656},"

List IP pool's linked silos

\n",[1118,1119,1120,1121],"system/networking/ip-pool/silo/list",{"_21":172,"_23":173},{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1122},[171],"

Link IP pool to silo

Users in linked silos can allocate external IPs from this pool for their instances. A silo can have at most one default pool. IPs are allocated from the default pool when users ask for one without specifying a pool.

\n",[1126,1127,1128,1129,1130,1131],"system/networking/ip-pool/silo/link",{"_21":674,"_23":1132,"_167":1133},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},{"_21":656},"When a pool is the default for a silo, floating IPs and instance ephemeral IPs will come from that pool when no other pool is specified.\n\nA silo can have at most one default pool per combination of pool type (unicast or multicast) and IP version (IPv4 or IPv6), allowing up to 4 default pools total.",[677,678],{"_21":22,"_23":24,"_25":26},"range",[1168],[1139,1140,1141],"system/networking/ip-pool/range",{"_13":731,"_15":1159,"_17":1160,"_19":1161},{"_13":156,"_15":1153,"_17":1154,"_19":1155},{"_13":715,"_15":1142,"_17":1143,"_19":1144},"

Remove range from IP pool

\n",[1145,1146,1147,1148,1149,1150],"system/networking/ip-pool/range/remove",{"_21":1152},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":1151},{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},"last","first","

List ranges for IP pool

Ranges are ordered by their first address.

\n",[1156,1157,1158],"system/networking/ip-pool/range/list",{"_21":172,"_23":173},{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},"

Add range to IP pool

For multicast pools, all ranges must be either Any-Source Multicast (ASM) or Source-Specific Multicast (SSM), but not both. Mixing ASM and SSM ranges in the same pool is not allowed.

ASM: IPv4 addresses outside 232.0.0.0/8, IPv6 addresses with flag field != 3 SSM: IPv4 addresses in 232.0.0.0/8, IPv6 addresses with flag field = 3

\n",[1162,1163,1164,1165,1166,1167],"system/networking/ip-pool/range/add",{"_21":1152},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":1151},{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"

List IP pools

\n",[1172,1173,1174,1175,1176,1177],"system/networking/ip-pool/list",{"_21":1184,"_167":1185},{"_21":769,"_167":1183},{"_21":172,"_23":173},{"_21":1179,"_167":1180},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1178},[169,170,171],"pool-type",[1181,1182],"unicast","multicast",[772,773],"assignment",[1186,1187],"silos","system_services","

Delete IP pool

\n",[1191,1192],"system/networking/ip-pool/delete",{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},"

Create IP pool

\n",[1196,1197,1198,1199,1200,1201,1202,1203],"system/networking/ip-pool/create",{"_21":1184,"_23":1208,"_167":1209},{"_21":117},{"_21":769,"_23":1206,"_167":1207},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":1179,"_23":1204,"_167":1205},{"_21":22,"_23":24,"_25":26},"Type of IP pool (defaults to Unicast)",[1181,1182],"The IP version of the pool.\n\nThe default is IPv4.",[772,773],"What this pool is assigned to (defaults to Silos).",[1186,1187],"assign","

Assign IP pool

\n",[1214,1215,1216,1217,1218],"system/networking/ip-pool/assign",{"_21":1184,"_167":1219},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},[1186,1187],{"_21":22,"_23":24,"_25":26},"inbound-icmp",[1240],[1225,1226],"system/networking/inbound-icmp",{"_13":100,"_15":1231,"_17":1232,"_19":1233},{"_13":90,"_15":1227,"_17":1228,"_19":1229},"

Return whether API services can receive limited ICMP traffic

\n",[1230],"system/networking/inbound-icmp/view",{"_21":22,"_23":24,"_25":26},"

Set whether API services can receive limited ICMP traffic

\n",[1234,1235,1236,1237],"system/networking/inbound-icmp/update",{"_21":981,"_23":1238,"_167":1239},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},"When enabled, Nexus is able to receive ICMP Destination Unreachable type 3 (port unreachable) and type 4 (fragmentation needed), Redirect, and Time Exceeded messages. These enable Nexus to perform Path MTU discovery and better cope with fragmentation issues. Otherwise all inbound ICMP traffic will be dropped.",[677,678],{"_21":22,"_23":24,"_25":26},"bgp",[1558],[1245,1246,1247,1248,1249,1250,1251,1252,1253,1254,1255,1256,1257,1258],"system/networking/bgp",{"_13":1545,"_15":1546,"_1000":1547,"_17":1548,"_19":1549},{"_13":1269,"_17":1515,"_27":1516,"_19":1517},{"_13":1503,"_17":1504,"_27":1505,"_19":1506},{"_13":1486,"_15":1487,"_1000":1488,"_17":1489,"_19":1490},{"_13":1432,"_17":1433,"_27":1434,"_19":1435},{"_13":1427,"_15":1428,"_17":1429,"_19":1430},{"_13":1399,"_15":1400,"_1000":1401,"_17":1402,"_19":1403},{"_13":1393,"_15":1394,"_17":1395,"_19":1396},{"_13":1385,"_15":1386,"_17":1387,"_19":1388},{"_13":1297,"_15":1301,"_1000":1302,"_17":1303,"_27":1304,"_19":1305},{"_13":1281,"_15":1282,"_1000":1283,"_17":1284,"_19":1285},{"_13":1275,"_15":1276,"_1000":1277,"_17":1278,"_19":1279},{"_13":498,"_15":1271,"_17":1272,"_19":1273},{"_13":1259,"_15":1260,"_1000":1261,"_17":1262,"_19":1263},"withdraw","

Withdraw a prefix over BGP.

\n","

Withdraw a prefix over BGP.

This command removes the provided prefix from the specified announce set.\nThe remove is performed as a read-modify-write on the announce set.

\n",[1264,1265,1266],"system/networking/bgp/withdraw",{"_21":1269,"_23":1270},{"_21":1267,"_23":1268},{"_21":22,"_23":24,"_25":26},"prefix","The prefix to withdraw","announce-set","The announce set to withdraw from","

Get BGP peer status

\n",[1274],"system/networking/bgp/status",{"_21":22,"_23":24,"_25":26},"show-status","

Get the status of BGP on the rack.

\n","

Get the status of BGP on the rack.

This will show the peering status for all peers on all switches.

\n",[1280],"system/networking/bgp/show-status",{"_21":22,"_23":24,"_25":26},"pref","

Set a local preference for a peer.

\n","

Set a local preference for a peer.

This command associates a local preference for the specified peer. When\nroutes are imported by this peer, they will be installed into the routing\ninformation base (RIB) with the specified preference. This command works\nby performing a read-modify-write on the switch port settings configuration\nidentified by the specified rack/switch/port.

\n",[1286,1287,1288,1289,1290,1291],"system/networking/bgp/pref",{"_21":1299,"_23":1300},{"_21":1297,"_23":1298},{"_21":592,"_23":1295,"_167":1296},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1294},{"_21":816,"_23":1292,"_167":1293},"Switch to set the route preference on",[819,820],"Id of the rack to set the route preference on","Port to set the route preference on",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"peer","Peer to set the route preference on","local-pref","Apply this local preference to routes received from the peer","

Manage BGP peers.

\n","

Manage BGP peers.

This command provides set and delete subcommands for managing BGP peers.\nBGP peer configuration is a part of a switch port settings configuration.\nThe peer set and delete subcommands perform read-modify-write operations\non switch port settings objects to manage BGP peer configurations.

\n",[1384],[1306,1307],"system/networking/bgp/peer",{"_13":184,"_15":1370,"_17":1371,"_19":1372},{"_13":802,"_15":1308,"_17":1309,"_19":1310},"

Set a BGP peer on a port configuration

\n",[1311,1312,1313,1314,1315,1316,1317,1318,1319,1320,1321,1322,1323,1324,1325,1326,1327,1328,1329,1330,1331,1332],"system/networking/bgp/peer/set",{"_21":1368,"_23":1369},{"_21":1366,"_23":1367},{"_21":1364,"_23":1365},{"_21":1362,"_23":1363},{"_21":1360,"_23":1361},{"_21":1358,"_23":1359},{"_21":1356,"_23":1357},{"_21":1354,"_23":1355},{"_21":1352,"_23":1353},{"_21":1350,"_23":1351},{"_21":1348,"_23":1349},{"_21":1346,"_23":1347},{"_21":1299,"_23":1300},{"_21":1344,"_23":1345},{"_21":1342,"_23":1343},{"_21":592,"_23":1340,"_167":1341},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1339},{"_21":1337,"_23":1338},{"_21":1336},{"_21":816,"_23":1334,"_167":1335},{"_21":814,"_23":1333},"Associate a VLAN ID with a peer","Switch to set the peer config on",[819,820],"router-lifetime","remote-asn","Require that a peer has a specified ASN","Id of the rack to set the peer config on","Port to set the peer config on",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"multi-exit-discriminator","Apply the provided multi-exit discriminator (MED) updates sent to the peer","min-ttl","Require messages from a peer have a minimum IP time to live field","keepalive","How often to send keepalive requests (seconds)","idle-hold-time","How long to hold a peer in idle before attempting a new session (seconds)","hold-time","How long to hold peer connections between keepalives (seconds)","enforce-first-as","Enforce that the first AS in paths received from this peer is the peer's AS","delay-open","How long to delay sending an open request after establishing a TCP session (seconds)","connect-retry","How long to wait between TCP connection retries (seconds)","communities","Include the provided communities in updates sent to the peer","bgp-config","BGP configuration this peer is associated with","authstring","Use the given authorization string for TCP-MD5 authentication with the peer","allowed-imports","Prefixes that may be imported from the peer. Empty list means all prefixes allowed","allowed-exports","Prefixes that may be exported to the peer. Empty list means all prefixes allowed","addr","Address of the peer to set the config for","

Remove a BGP from a port configuration

\n",[1373,1374,1375,1376,1377],"system/networking/bgp/peer/delete",{"_21":1368,"_23":1383},{"_21":592,"_23":1381,"_167":1382},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1380},{"_21":816,"_23":1378,"_167":1379},"Switch to remove the peer from",[819,820],"Id of the rack to remove the peer from","Port to remove the peer from",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"Address of the peer to remove",{"_21":22,"_23":24,"_25":26},"imported","

Get imported IPv4 BGP routes

\n",[1389,1390],"system/networking/bgp/imported",{"_21":1391,"_23":1392},{"_21":22,"_23":24,"_25":26},"asn","The ASN to filter on. Required.","history","

Get BGP router message history

\n",[1397,1398],"system/networking/bgp/history",{"_21":1391,"_23":1392},{"_21":22,"_23":24,"_25":26},"filter","

Add a filtering requirement to a BGP session.

\n","

Add a filtering requirement to a BGP session.

The Oxide BGP implementation can filter prefixes received from peers\non import and filter prefixes sent to peers on export. This command\nprovides a way to specify import/export filtering. Filtering is a\nproperty of the BGP peering settings found in the port settings configuration.\nThis command works by performing a read-modify-write on the port settings\nconfiguration identified by the specified rack/switch/port.

\n",[1404,1405,1406,1407,1408,1409,1410,1411],"system/networking/bgp/filter",{"_21":1425,"_23":1426},{"_21":1420,"_23":1421,"_167":1422},{"_21":1418,"_23":1419},{"_21":1297,"_23":1417},{"_21":592,"_23":1415,"_167":1416},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1414},{"_21":816,"_23":1412,"_167":1413},"Switch to add the filter to",[819,820],"Id of the rack to add the filter to","Port to add the filter to",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"Peer to apply allow list to","no-filtering","Do not filter","direction","Whether to apply the filter to imported or exported prefixes",[1423,1424],"import","export","allowed","Prefixes to allow for the peer","exported","

List BGP exported routes

\n",[1431],"system/networking/bgp/exported",{"_21":22,"_23":24,"_25":26},"config",[1485],[1436,1437,1438,1439],"system/networking/bgp/config",{"_13":192,"_15":1469,"_17":1470,"_19":1471},{"_13":184,"_15":1464,"_17":1465,"_19":1466},{"_13":156,"_15":1457,"_17":1458,"_19":1459},{"_13":100,"_15":1440,"_17":1441,"_19":1442},"

Update the mutable fields of an existing BGP configuration

The asn field is not updatable; to change the autonomous system number, create a new BGP configuration object.

\n",[1443,1444,1445,1446,1447,1448,1449,1450],"system/networking/bgp/config/update",{"_21":1455,"_23":1456},{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":1453,"_23":1454},{"_21":13},{"_21":1451,"_23":1452},{"_21":22,"_23":24,"_25":26},"name-or-id","A name or id to use when selecting BGP config.","max-paths","Update the maximum number of equal-cost paths.","bgp-announce-set-id","Update the BGP announce set associated with this configuration.","

List BGP configurations

\n",[1460,1461,1462],"system/networking/bgp/config/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1463},[169,170,171],"

Delete BGP configuration

\n",[1467,1468],"system/networking/bgp/config/delete",{"_21":1451,"_23":1452},{"_21":22,"_23":24,"_25":26},"

Create BGP configuration

\n",[1472,1473,1474,1475,1476,1477,1478,1479,1480],"system/networking/bgp/config/create",{"_21":1391,"_23":1484},{"_21":1455},{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":1453,"_23":1483},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":1481,"_23":1482},"vrf","Optional virtual routing and forwarding identifier for this BGP configuration.","Maximum number of paths to use when multiple \"best paths\" exist","The autonomous system number of this BGP configuration.",{"_21":22,"_23":24,"_25":26},"auth","

Set an authentication string.

\n","

Set an authentication string.

This command sets the authentication string that the specified BGP session\nwill use for establishing a TCP-MD5 authenticated connection with its peer.\nThis command works by performing a read-modify-write on the switch port\nsettings configuration identified by the specified rack/switch/port.

\n",[1491,1492,1493,1494,1495,1496],"system/networking/bgp/auth",{"_21":1362,"_23":1363},{"_21":1297,"_23":1502},{"_21":592,"_23":1500,"_167":1501},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1499},{"_21":816,"_23":1497,"_167":1498},"Switch to add the auth config to",[819,820],"Id of the rack to add the auth config to","Port to add the auth config to",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"Peer to add the auth config to","announcement",[1514],[1507],"system/networking/bgp/announcement",{"_13":156,"_15":1508,"_17":1509,"_19":1510},"

Get originated routes for a specified BGP announce set

\n",[1511,1512],"system/networking/bgp/announcement/list",{"_21":1269,"_23":1513},{"_21":22,"_23":24,"_25":26},"Name or ID of the announce set",{"_21":22,"_23":24,"_25":26},[1544],[1518,1519,1520],"system/networking/bgp/announce-set",{"_13":184,"_15":1539,"_17":1540,"_19":1541},{"_13":156,"_15":1529,"_17":1530,"_19":1531},{"_13":100,"_15":1521,"_17":1522,"_19":1523},"

Update BGP announce set

If the announce set exists, this endpoint replaces the existing announce set with the one specified.

\n",[1524,1525,1526,1527,1528],"system/networking/bgp/announce-set/update",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},"

List BGP announce sets

\n",[1532,1533,1534,1535],"system/networking/bgp/announce-set/list",{"_21":172,"_23":173},{"_21":1537,"_23":1538},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1536},[169,170,171],"page-token","Token returned by previous call to retrieve the subsequent page","

Delete BGP announce set

\n",[1542,1543],"system/networking/bgp/announce-set/delete",{"_21":1269,"_23":1513},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"announce","

Announce a prefix over BGP.

\n","

Announce a prefix over BGP.

This command adds the provided prefix to the specified announce set. It is\nrequired that the prefix be available in the given address lot. The add is\nperformed as a read-modify-write on the announce set.

\n",[1550,1551,1552,1553,1554],"system/networking/bgp/announce",{"_21":929,"_23":1557},{"_21":1269,"_23":1556},{"_21":117},{"_21":1267,"_23":1555},{"_21":22,"_23":24,"_25":26},"The prefix to announce","The announce set to announce from","The address lot to draw from",{"_21":22,"_23":24,"_25":26},"bfd",[1610],[1563,1564,1565],"system/networking/bfd",{"_13":1598,"_15":1599,"_17":1600,"_19":1601},{"_13":1570,"_15":1571,"_17":1572,"_19":1573},{"_13":498,"_15":1566,"_17":1567,"_19":1568},"

Get BFD status

\n",[1569],"system/networking/bfd/status",{"_21":22,"_23":24,"_25":26},"enable","

Enable BFD session

\n",[1574,1575,1576,1577,1578,1579,1580,1581,1582],"system/networking/bfd/enable",{"_21":1596,"_23":1597},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":1594,"_23":1595},{"_21":1589,"_23":1590,"_167":1591},{"_21":22,"_23":24,"_25":26},{"_21":1587,"_23":1588},{"_21":1585,"_23":1586},{"_21":901,"_23":1583,"_167":1584},"The slot of the switch within the rack to enable this session on.",[819,820],"required-rx","The minimum interval, in microseconds, between received BFD Control packets that this system requires","remote","Address of the remote peer to establish a BFD session with.","mode","Select either single-hop (RFC 5881) or multi-hop (RFC 5883)",[1592,1593],"single_hop","multi_hop","local","Address the Oxide switch will listen on for BFD traffic. If `None` then the unspecified address (0.0.0.0 or ::) is used.","detection-threshold","The negotiated Control packet transmission interval, multiplied by this variable, will be the Detection Time for this session (as seen by the remote system)","disable","

Disable BFD session

\n",[1602,1603,1604,1605,1606],"system/networking/bfd/disable",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":1587,"_23":1609},{"_21":901,"_23":1607,"_167":1608},"The slot of the switch within the rack to disable this session on.",[819,820],"Address of the remote peer to disable a BFD session for.",{"_21":22,"_23":24,"_25":26},"allow-list",[1631],[1615,1616],"system/networking/allow-list",{"_13":100,"_15":1621,"_17":1622,"_19":1623},{"_13":90,"_15":1617,"_17":1618,"_19":1619},"

Get user-facing services IP allowlist

\n",[1620],"system/networking/allow-list/view",{"_21":22,"_23":24,"_25":26},"

Update user-facing services IP allowlist

\n",[1624,1625,1626,1627,1628],"system/networking/allow-list/update",{"_21":1630},{"_21":1629},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},"ip","any",{"_21":22,"_23":24,"_25":26},[1685],[1635,1636,1637,1638,1639],"system/networking/address-lot",{"_13":1671,"_17":1672,"_27":1673,"_19":1674},{"_13":192,"_15":1658,"_17":1659,"_19":1660},{"_13":184,"_15":1653,"_17":1654,"_19":1655},{"_13":156,"_15":1646,"_17":1647,"_19":1648},{"_13":90,"_15":1640,"_17":1641,"_19":1642},"

Fetch address lot

\n",[1643,1644],"system/networking/address-lot/view",{"_21":929,"_23":1645},{"_21":22,"_23":24,"_25":26},"Name or ID of the address lot","

List address lots

\n",[1649,1650,1651],"system/networking/address-lot/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1652},[169,170,171],"

Delete address lot

\n",[1656,1657],"system/networking/address-lot/delete",{"_21":929,"_23":1645},{"_21":22,"_23":24,"_25":26},"

Create address lot

\n",[1661,1662,1663,1664,1665,1666],"system/networking/address-lot/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":1667,"_23":1668,"_167":1669},{"_21":13},{"_21":22,"_23":24,"_25":26},"kind","The kind of address lot to create.",[1670,640],"infra","block",[1684],[1675],"system/networking/address-lot/block",{"_13":156,"_15":1676,"_17":1677,"_19":1678},"

List blocks in address lot

\n",[1679,1680,1681,1682],"system/networking/address-lot/block/list",{"_21":929,"_23":1645},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1683},[171],{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"

Manage switch port addresses.

\n",[1726],[1690,1691],"system/networking/addr",{"_13":731,"_15":1706,"_17":1707,"_19":1708},{"_13":184,"_15":1692,"_17":1693,"_19":1694},"

Remove an address from a port configuration

\n",[1695,1696,1697,1698,1699],"system/networking/addr/delete",{"_21":1368,"_23":1705},{"_21":592,"_23":1703,"_167":1704},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1702},{"_21":816,"_23":1700,"_167":1701},"Switch to remove the address from",[819,820],"Id of the rack to remove the address from","Port to remove the address from",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"Address to remove","

Add an address to a port configuration

\n",[1709,1710,1711,1712,1713,1714,1715],"system/networking/addr/add",{"_21":1368,"_23":1725},{"_21":1723,"_23":1724},{"_21":592,"_23":1721,"_167":1722},{"_21":22,"_23":24,"_25":26},{"_21":823,"_23":1720},{"_21":816,"_23":1718,"_167":1719},{"_21":1716,"_23":1717},"vlan","Optional VLAN to assign to the address","Switch to add the address to",[819,820],"Id of the rack to add the address to","Port to add the address to",[827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858],"lot","Address lot to allocate from","Address to add",{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"hardware",[1981],[1732,1733,1734,1735,1736],"system/hardware",{"_13":1921,"_17":1922,"_27":1923,"_19":1924},{"_13":823,"_17":1874,"_27":1875,"_19":1876},{"_13":1811,"_17":1812,"_27":1813,"_19":1814},{"_13":816,"_17":1791,"_27":1792,"_19":1793},{"_13":1737,"_17":1738,"_27":1739,"_19":1740},"switch-port",[1790],[1741,1742,1743,1744,1745],"system/hardware/switch-port",{"_13":1777,"_15":1778,"_17":1779,"_19":1780},{"_13":1768,"_15":1769,"_17":1770,"_19":1771},{"_13":156,"_15":1758,"_17":1759,"_19":1760},{"_13":1275,"_15":1754,"_17":1755,"_19":1756},{"_13":498,"_15":1746,"_17":1747,"_19":1748},"

Get switch port status

\n",[1749,1750,1751,1752],"system/hardware/switch-port/status",{"_21":592,"_23":950},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":949},{"_21":901,"_23":947,"_167":1753},[819,820],"

Get the status of switch ports.

\n",[1757],"system/hardware/switch-port/show-status",{"_21":22,"_23":24,"_25":26},"

List switch ports

\n",[1761,1762,1763,1764],"system/hardware/switch-port/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1767},{"_21":1765,"_23":1766},"switch-port-id","An optional switch port id to use when listing switch ports.",[171],"clear-settings","

Clear switch port settings

\n",[1772,1773,1774,1775],"system/hardware/switch-port/clear-settings",{"_21":592,"_23":950},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":949},{"_21":901,"_23":947,"_167":1776},[819,820],"apply-settings","

Apply switch port settings

\n",[1781,1782,1783,1784,1785,1786,1787],"system/hardware/switch-port/apply-settings",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":592,"_23":950},{"_21":607,"_23":1789},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":949},{"_21":901,"_23":947,"_167":1788},[819,820],"A name or id to use when applying switch port settings.",{"_21":22,"_23":24,"_25":26},[1810],[1794,1795],"system/hardware/switch",{"_13":156,"_15":1803,"_17":1804,"_19":1805},{"_13":90,"_15":1796,"_17":1797,"_19":1798},"

Fetch switch

\n",[1799,1800],"system/hardware/switch/view",{"_21":22,"_23":24,"_25":26},{"_21":1801,"_23":1802},"switch-id","ID of the switch","

List switches

\n",[1806,1807,1808],"system/hardware/switch/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1809},[171],{"_21":22,"_23":24,"_25":26},"sled",[1873],[1815,1816,1817,1818,1819,1820],"system/hardware/sled",{"_13":1864,"_15":1865,"_17":1866,"_19":1867},{"_13":1855,"_15":1856,"_17":1857,"_19":1858},{"_13":156,"_15":1848,"_17":1849,"_19":1850},{"_13":1842,"_15":1843,"_17":1844,"_19":1845},{"_13":1828,"_15":1829,"_17":1830,"_19":1831},{"_13":90,"_15":1821,"_17":1822,"_19":1823},"

Fetch sled

\n",[1824,1825],"system/hardware/sled/view",{"_21":22,"_23":24,"_25":26},{"_21":1826,"_23":1827},"sled-id","ID of the sled","set-provision-policy","

Set sled provision policy

\n",[1832,1833,1834,1835,1836],"system/hardware/sled/set-provision-policy",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":1826,"_23":1827},{"_21":1837,"_23":1838,"_167":1839},"state","The provision state.",[1840,1841],"provisionable","non_provisionable","list-uninitialized","

List uninitialized sleds

\n",[1846,1847],"system/hardware/sled/list-uninitialized",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},"

List sleds

\n",[1851,1852,1853],"system/hardware/sled/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1854},[171],"instance-list","

List instances running on given sled

\n",[1859,1860,1861,1862],"system/hardware/sled/instance-list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":1826,"_23":1827},{"_21":166,"_167":1863},[171],"disk-list","

List physical disks attached to sleds

\n",[1868,1869,1870,1871],"system/hardware/sled/disk-list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":1826,"_23":1827},{"_21":166,"_167":1872},[171],{"_21":22,"_23":24,"_25":26},[1920],[1877,1878,1879],"system/hardware/rack",{"_13":156,"_15":1913,"_17":1914,"_19":1915},{"_13":1886,"_17":1887,"_27":1888,"_19":1889},{"_13":90,"_15":1880,"_17":1881,"_19":1882},"

Fetch rack

\n",[1883,1884],"system/hardware/rack/view",{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":1885},"ID of the rack","membership",[1912],[1890,1891,1892],"system/hardware/rack/membership",{"_13":1906,"_15":1907,"_17":1908,"_19":1909},{"_13":731,"_15":1899,"_17":1900,"_19":1901},{"_13":498,"_15":1893,"_17":1894,"_19":1895},"

Fetch rack cluster membership status

Returns the status for the most recent change, or a specific version if one is specified.

\n",[1896,1897,1898],"system/hardware/rack/membership/status",{"_21":22,"_23":24,"_25":26},{"_21":906},{"_21":31},"

Add new sleds to rack membership

\n",[1902,1903,1904,1905],"system/hardware/rack/membership/add",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":1885},"abort","

Abort the latest rack membership change

This operation is synchronous. Upon returning from the API call, a success response indicates that the prior membership change was aborted. An error response indicates that there is no active membership change in progress (previous changes have completed) or that the current membership change could not be aborted.

\n",[1910,1911],"system/hardware/rack/membership/abort",{"_21":22,"_23":24,"_25":26},{"_21":906,"_23":1885},{"_21":22,"_23":24,"_25":26},"

List racks

\n",[1916,1917,1918],"system/hardware/rack/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1919},[171],{"_21":22,"_23":24,"_25":26},"disk",[1980],[1925,1926,1927,1928,1929,1930],"system/hardware/disk",{"_13":1972,"_15":1973,"_17":1974,"_19":1975},{"_13":1964,"_15":1965,"_17":1966,"_19":1967},{"_13":1951,"_15":1952,"_17":1953,"_19":1954},{"_13":156,"_15":1944,"_17":1945,"_19":1946},{"_13":1938,"_15":1939,"_17":1940,"_19":1941},{"_13":90,"_15":1931,"_17":1932,"_19":1933},"

Get physical disk

\n",[1934,1935],"system/hardware/disk/view",{"_21":1936,"_23":1937},{"_21":22,"_23":24,"_25":26},"disk-id","ID of the physical disk","list-unadopted","

List physical disks that have not yet been adopted for use

\n",[1942,1943],"system/hardware/disk/list-unadopted",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},"

List physical disks

\n",[1947,1948,1949],"system/hardware/disk/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1950},[171],"enable-adoption","

Enable adoption of a physical disk for general use

\n",[1955,1956,1957,1958,1959,1960],"system/hardware/disk/enable-adoption",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":1963},{"_21":22,"_23":24,"_25":26},{"_21":1962},{"_21":1961},"vendor","serial","model","disable-adoption","

Disable adoption of a physical disk for general use

\n",[1968,1969],"system/hardware/disk/disable-adoption",{"_21":1970,"_23":1971},{"_21":22,"_23":24,"_25":26},"physical-disk-adoption-req-id","ID of the physical disk adoption request","adoption-requests","

List physical disk adoption requests

\n",[1976,1977,1978],"system/hardware/disk/adoption-requests",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1979},[171],{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},[1997],[1985,1986],{"_13":156,"_15":748,"_17":1991,"_19":1992},{"_13":90,"_15":635,"_17":1987,"_19":1988},[1989,1990],"subnet-pool/view",{"_21":640,"_23":641},{"_21":22,"_23":24,"_25":26},[1993,1994,1995],"subnet-pool/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":1996},[169,170,171],{"_21":22,"_23":24,"_25":26},"snapshot",[2037],[2001,2002,2003,2004],{"_13":192,"_15":2026,"_17":2027,"_19":2028},{"_13":184,"_15":2020,"_17":2021,"_19":2022},{"_13":156,"_15":2012,"_17":2013,"_19":2014},{"_13":90,"_15":2005,"_17":2006,"_19":2007},"

Fetch snapshot

\n",[2008,2009,2010],"snapshot/view",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":1998,"_23":2011},"Name or ID of the snapshot","

List snapshots

\n",[2015,2016,2017,2018],"snapshot/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":2019},[169,170,171],"

Delete snapshot

\n",[2023,2024,2025],"snapshot/delete",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":1998,"_23":2011},"

Create snapshot

Creates a point-in-time snapshot from a disk.

\n",[2029,2030,2031,2032,2033,2034,2035],"snapshot/create",{"_21":117},{"_21":1921,"_23":2036},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"The disk to be snapshotted",{"_21":22,"_23":24,"_25":26},[2314],[2040,2041,2042,2043,2044,2045,2046,2047,2048,2049,2050],{"_13":192,"_15":2294,"_17":2295,"_19":2296},{"_13":184,"_15":2289,"_17":2290,"_19":2291},{"_13":2182,"_17":2183,"_27":2184,"_19":2185},{"_13":1058,"_17":2169,"_27":2170,"_19":2171},{"_13":156,"_15":2162,"_17":2163,"_19":2164},{"_13":543,"_17":2144,"_27":2145,"_19":2146},{"_13":2108,"_17":2109,"_27":2110,"_19":2111},{"_13":623,"_17":2095,"_27":2096,"_19":2097},{"_13":385,"_17":2074,"_27":2075,"_19":2076},{"_13":381,"_17":2056,"_27":2057,"_19":2058},{"_13":90,"_15":2051,"_17":2052,"_19":2053},"

Fetch silo

Fetch silo by name or ID.

\n",[2054,2055],"silo/view",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},[2073],[2059,2060],"silo/utilization",{"_13":156,"_15":2066,"_17":2067,"_19":2068},{"_13":90,"_15":2061,"_17":2062,"_19":2063},"

Fetch current utilization for given silo

\n",[2064,2065],"silo/utilization/view",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},"

List current utilization state for all silos

\n",[2069,2070,2071],"silo/utilization/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":2072},[169,170,171],{"_21":22,"_23":24,"_25":26},[2094],[2077,2078],"silo/user",{"_13":156,"_15":2086,"_17":2087,"_19":2088},{"_13":90,"_15":2079,"_17":2080,"_19":2081},"

Fetch built-in (system) user

\n",[2082,2083,2084],"silo/user/view",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":398,"_23":2085},"The user's internal ID","

List built-in (system) users in silo

\n",[2089,2090,2091,2092],"silo/user/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":166,"_167":2093},[171],{"_21":22,"_23":24,"_25":26},[2107],[2098],"silo/subnet-pool",{"_13":156,"_15":2099,"_17":2100,"_19":2101},"

List subnet pools linked to a silo

\n",[2102,2103,2104,2105],"silo/subnet-pool/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":166,"_167":2106},[169,170,171],{"_21":22,"_23":24,"_25":26},"quotas",[2143],[2112,2113,2114],"silo/quotas",{"_13":156,"_15":2136,"_17":2137,"_19":2138},{"_13":100,"_15":2120,"_17":2121,"_19":2122},{"_13":90,"_15":2115,"_17":2116,"_19":2117},"

Fetch resource quotas for silo

\n",[2118,2119],"silo/quotas/view",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},"

Update resource quotas for silo

If a quota value is not specified, it will remain unchanged.

\n",[2123,2124,2125,2126,2127,2128,2129],"silo/quotas/update",{"_21":2134,"_23":2135},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":2132,"_23":2133},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":2130,"_23":2131},"storage","The amount of storage available for disks or snapshots; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib","memory","The amount of RAM available for running instances in the Silo; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib","cpus","The amount of virtual CPUs available for running instances in the Silo","

List resource quotas for all silos

\n",[2139,2140,2141],"silo/quotas/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":2142},[171],{"_21":22,"_23":24,"_25":26},[2161],[2147,2148],"silo/policy",{"_13":100,"_15":2154,"_17":2155,"_19":2156},{"_13":90,"_15":2149,"_17":2150,"_19":2151},"

Fetch silo IAM policy

\n",[2152,2153],"silo/policy/view",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},"

Update silo IAM policy

\n",[2157,2158,2159,2160],"silo/policy/update",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":22,"_23":24,"_25":26},"

List silos

Lists silos that are discoverable based on the current permissions.

\n",[2165,2166,2167],"silo/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":2168},[169,170,171],[2181],[2172],"silo/ip-pool",{"_13":156,"_15":2173,"_17":2174,"_19":2175},"

List IP pools linked to silo

Linked IP pools are available to users in the specified silo. A silo can have at most one default pool. IPs are allocated from the default pool when users ask for one without specifying a pool.

\n",[2176,2177,2178,2179],"silo/ip-pool/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":166,"_167":2180},[169,170,171],{"_21":22,"_23":24,"_25":26},"idp",[2288],[2186,2187,2188],"silo/idp",{"_13":156,"_15":2280,"_17":2281,"_19":2282},{"_13":1594,"_17":2243,"_27":2244,"_19":2245},{"_13":2189,"_17":2190,"_27":2191,"_19":2192},"saml",[2242],[2193,2194],"silo/idp/saml",{"_13":192,"_15":2203,"_17":2204,"_19":2205},{"_13":90,"_15":2195,"_17":2196,"_19":2197},"

Fetch SAML identity provider

\n",[2198,2199,2200],"silo/idp/saml/view",{"_21":22,"_23":24,"_25":26},{"_21":2201,"_23":2202},{"_21":656,"_23":673},"provider","Name or ID of the SAML identity provider","

Create SAML identity provider

\n",[2206,2207,2208,2209,2210,2211,2212,2213,2214,2215,2216,2217,2218,2219,2220,2221],"silo/idp/saml/create",{"_21":2240,"_23":2241},{"_21":117},{"_21":2238,"_23":2239},{"_21":2236,"_23":2237},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":2234,"_23":2235},{"_21":2232,"_23":2233},{"_21":13},{"_21":2230,"_23":2231},{"_21":22,"_23":24,"_25":26},{"_21":2228,"_23":2229},{"_21":656,"_23":673},{"_21":2226,"_23":2227},{"_21":2224,"_23":2225},{"_21":2222,"_23":2223},"technical-contact-email","Customer's technical contact for SAML configuration","sp-client-id","SP's client ID","slo-url","Service provider endpoint where the IdP should send log out requests","public-cert","path to the request signing public certificate in DER format","private-key","path to the request signing RSA private key in PKCS#1 DER format","metadata-value","path to an XML file containing an identity provider metadata descriptor","metadata-url","the URL of an identity provider metadata descriptor","idp-entity-id","IdP's entity ID","group-attribute-name","If set, SAML attributes with this name will be considered to denote a user's group membership, where the attribute value(s) should be a comma-separated list of group names.","acs-url","Service provider endpoint where the response will be sent",{"_21":22,"_23":24,"_25":26},[2279],[2246],"silo/idp/local",{"_13":385,"_17":2247,"_27":2248,"_19":2249},[2278],[2250,2251,2252],"silo/idp/local/user",{"_13":192,"_15":2268,"_17":2269,"_19":2270},{"_13":184,"_15":2262,"_17":2263,"_19":2264},{"_13":2253,"_15":2254,"_17":2255,"_19":2256},"set-password","

Set or invalidate user's password

Passwords can only be updated for users in Silos with identity mode LocalOnly.

\n",[2257,2258,2259,2260,2261],"silo/idp/local/user/set-password",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":398,"_23":2085},"

Delete user

\n",[2265,2266,2267],"silo/idp/local/user/delete",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":398,"_23":2085},"

Create user

Users can only be created in Silos with provision_type == Fixed. Otherwise, Silo users are just-in-time (JIT) provisioned when a user first logs in using an external Identity Provider.

\n",[2271,2272,2273,2274,2275],"silo/idp/local/user/create",{"_21":2276,"_23":2277},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},"external-id","Username used to log in",{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"

List identity providers for silo

List identity providers for silo by silo name or ID.

\n",[2283,2284,2285,2286],"silo/idp/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":166,"_167":2287},[169,170,171],{"_21":22,"_23":24,"_25":26},"

Delete silo

Delete a silo by name or ID.

\n",[2292,2293],"silo/delete",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},"

Create silo

\n",[2297,2298,2299,2300,2301,2302,2303,2304],"silo/create",{"_21":2312,"_23":2313},{"_21":117},{"_21":2310,"_167":2311},{"_21":2305,"_167":2306},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},"identity-mode",[2307,2308,2309],"saml_jit","local_only","saml_scim","discoverable",[677,678],"admin-group-name","If set, this group will be created during Silo creation and granted the \"Silo Admin\" role. Identity providers can assert that users belong to this group and those users can log in and further initialize the Silo.\n\nNote that if configuring a SAML based identity provider, group_attribute_name must be set for users to be considered part of a group. See `SamlIdentityProviderCreate` for more information.",{"_21":22,"_23":24,"_25":26},"scim",[2351],[2318],{"_13":2319,"_17":2320,"_27":2321,"_19":2322},"token",[2350],[2323,2324,2325,2326],"scim/token",{"_13":192,"_15":2345,"_17":2346,"_19":2347},{"_13":184,"_15":2339,"_17":2340,"_19":2341},{"_13":156,"_15":2334,"_17":2335,"_19":2336},{"_13":90,"_15":2327,"_17":2328,"_19":2329},"

Fetch SCIM token

Specify the silo by name or ID using the silo query parameter.

\n",[2330,2331,2332],"scim/token/view",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":2333},"token-id","

List SCIM tokens

Specify the silo by name or ID using the silo query parameter.

\n",[2337,2338],"scim/token/list",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},"

Delete SCIM token

Specify the silo by name or ID using the silo query parameter.

\n",[2342,2343,2344],"scim/token/delete",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":2333},"

Create SCIM token

Specify the silo by name or ID using the silo query parameter. Be sure to save the bearer token in the response. It will not be retrievable later through the token view and list endpoints.

\n",[2348,2349],"scim/token/create",{"_21":22,"_23":24,"_25":26},{"_21":656,"_23":673},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},[2412],[2354,2355,2356,2357,2358,2359],{"_13":192,"_15":2404,"_17":2405,"_19":2406},{"_13":184,"_15":2399,"_17":2400,"_19":2401},{"_13":156,"_15":2392,"_17":2393,"_19":2394},{"_13":543,"_17":2374,"_27":2375,"_19":2376},{"_13":100,"_15":2365,"_17":2366,"_19":2367},{"_13":90,"_15":2360,"_17":2361,"_19":2362},"

Fetch project

\n",[2363,2364],"project/view",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Update project

\n",[2368,2369,2370,2371,2372,2373],"project/update",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},[2391],[2377,2378],"project/policy",{"_13":100,"_15":2384,"_17":2385,"_19":2386},{"_13":90,"_15":2379,"_17":2380,"_19":2381},"

Fetch project's IAM policy

\n",[2382,2383],"project/policy/view",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Update project's IAM policy

\n",[2387,2388,2389,2390],"project/policy/update",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":22,"_23":24,"_25":26},"

List projects

\n",[2395,2396,2397],"project/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":2398},[169,170,171],"

Delete project

\n",[2402,2403],"project/delete",{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create project

\n",[2407,2408,2409,2410,2411],"project/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},[2427],[2415,2416],{"_13":100,"_15":2421,"_17":2422,"_19":2423},{"_13":90,"_15":2417,"_17":2418,"_19":2419},"

Fetch current silo's IAM policy

\n",[2420],"policy/view",{"_21":22,"_23":24,"_25":26},"

Update current silo's IAM policy

\n",[2424,2425,2426],"policy/update",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},[2446],[2430,2431],{"_13":156,"_15":1169,"_17":2436,"_19":2437},{"_13":90,"_15":1071,"_17":2432,"_19":2433},[2434,2435],"ip-pool/view",{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},[2438,2439,2440,2441,2442],"ip-pool/list",{"_21":769,"_167":2445},{"_21":172,"_23":173},{"_21":1179,"_167":2444},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":2443},[169,170,171],[1181,1182],[772,773],{"_21":22,"_23":24,"_25":26},"internet-gateway",[2578],[2450,2451,2452,2453,2454,2455],{"_13":908,"_17":2538,"_27":2539,"_19":2540},{"_13":192,"_15":2528,"_17":2529,"_19":2530},{"_13":184,"_15":2519,"_17":2520,"_19":2521},{"_13":1058,"_17":2474,"_27":2475,"_19":2476},{"_13":156,"_15":2465,"_17":2466,"_19":2467},{"_13":90,"_15":2456,"_17":2457,"_19":2458},"

Fetch internet gateway

\n",[2459,2460,2461,2462],"internet-gateway/view",{"_21":2463,"_23":2464},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":97},"gateway","Name or ID of the gateway","

List internet gateways

\n",[2468,2469,2470,2471,2472],"internet-gateway/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":166,"_167":2473},{"_21":79,"_23":97},[169,170,171],[2518],[2477,2478,2479],"internet-gateway/ip-pool",{"_13":2505,"_15":2506,"_17":2507,"_19":2508},{"_13":2492,"_15":2493,"_17":2494,"_19":2495},{"_13":156,"_15":2480,"_17":2481,"_19":2482},"

List IP pools attached to internet gateway

\n",[2483,2484,2485,2486,2487,2488],"internet-gateway/ip-pool/list",{"_21":2463,"_23":2491},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":166,"_167":2490},{"_21":79,"_23":2489},"Name or ID of the VPC, only required if `gateway` is provided as a `Name`",[169,170,171],"Name or ID of the internet gateway","detach","

Detach IP pool from internet gateway

\n",[2496,2497,2498,2499,2500,2501],"internet-gateway/ip-pool/detach",{"_21":2502,"_23":2503,"_167":2504},{"_21":2463,"_23":2491},{"_21":640,"_23":1076},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":2489},"cascade","Detach attached IP pools/addresses and delete any routes targeting this gateway. Without `cascade`, delete fails if the gateway has any IP pools or IP addresses attached.",[677,678],"attach","

Attach IP pool to internet gateway

\n",[2509,2510,2511,2512,2513,2514,2515,2516,2517],"internet-gateway/ip-pool/attach",{"_21":117},{"_21":2463,"_23":2491},{"_21":1058},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":2489},{"_21":22,"_23":24,"_25":26},"

Delete internet gateway

\n",[2522,2523,2524,2525,2526],"internet-gateway/delete",{"_21":2502,"_23":2503,"_167":2527},{"_21":2463,"_23":2464},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":97},[677,678],"

Create VPC internet gateway

\n",[2531,2532,2533,2534,2535,2536,2537],"internet-gateway/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":97},[2577],[2541,2542,2543],"internet-gateway/address",{"_13":192,"_15":2565,"_17":2566,"_19":2567},{"_13":184,"_15":2554,"_17":2555,"_19":2556},{"_13":156,"_15":2544,"_17":2545,"_19":2546},"

List IP addresses attached to internet gateway

\n",[2547,2548,2549,2550,2551,2552],"internet-gateway/address/list",{"_21":2463,"_23":2491},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":166,"_167":2553},{"_21":79,"_23":2489},[169,170,171],"

Detach IP address from internet gateway

\n",[2557,2558,2559,2560,2561,2562],"internet-gateway/address/delete",{"_21":908,"_23":2564},{"_21":2502,"_23":2503,"_167":2563},{"_21":2463,"_23":2491},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":2489},[677,678],"Name or ID of the IP address","

Attach IP address to internet gateway

\n",[2568,2569,2570,2571,2572,2573,2574,2575,2576],"internet-gateway/address/create",{"_21":908},{"_21":117},{"_21":2463,"_23":2491},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":136},{"_21":79,"_23":2489},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"instance",[3060],[2582,2583,2584,2585,2586,2587,2588,2589,2590,2591,2592,2593,2594,2595,2596,2597],{"_13":2725,"_17":2962,"_27":2963,"_19":2964},{"_13":192,"_15":2936,"_17":2937,"_19":2938},{"_13":184,"_15":2930,"_17":2931,"_19":2932},{"_13":1921,"_17":2895,"_27":2896,"_19":2897},{"_13":2862,"_17":2863,"_27":2864,"_19":2865},{"_13":2850,"_17":2851,"_27":2852,"_19":2853},{"_13":2819,"_15":2820,"_17":2821,"_19":2822},{"_13":156,"_15":2811,"_17":2812,"_19":2813},{"_13":151,"_17":2746,"_27":2747,"_19":2748},{"_13":2708,"_17":2709,"_27":2710,"_19":2711},{"_13":2701,"_15":2702,"_17":2703,"_19":2704},{"_13":1962,"_15":2652,"_17":2653,"_27":2654,"_19":2655},{"_13":2645,"_15":2646,"_17":2647,"_19":2648},{"_13":2638,"_15":2639,"_17":2640,"_19":2641},{"_13":100,"_15":2605,"_17":2606,"_19":2607},{"_13":90,"_15":2598,"_17":2599,"_19":2600},"

Fetch instance

\n",[2601,2602,2603],"instance/view",{"_21":2579,"_23":2604},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"Name or ID of the instance","

Update instance

\n",[2608,2609,2610,2611,2612,2613,2614,2615,2616,2617,2618],"instance/update",{"_21":2633,"_23":2634,"_167":2635},{"_21":2631,"_23":2632},{"_21":2625,"_23":2626,"_167":2627},{"_21":2622,"_23":2623,"_167":2624},{"_21":2579,"_23":2604},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":2132,"_23":2621},{"_21":2619,"_23":2620},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"ncpus","The number of vCPUs to be allocated to the instance","The amount of RAM to be allocated to the instance; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib","enable-jumbo-frames","Update the per-instance jumbo-frames opt-in. Setting this to `true` requires the fleet-wide jumbo-frames opt-in to be enabled. Changes only take effect on the next instance restart.",[677,678],"cpu-platform","The CPU platform to be used for this instance. If this is `null`, the instance requires no particular CPU platform; when it is started the instance will have the most general CPU platform supported by the sled it is initially placed on.",[2628,2629,2630],"amd_milan","amd_turin","amd_turin_v2","boot-disk","The disk the instance is configured to boot from.\n\nSetting a boot disk is optional but recommended to ensure predictable boot behavior. The boot disk can be set during instance creation or later if the instance is stopped. The boot disk counts against the disk attachment limit.\n\nAn instance that does not have a boot disk set will use the boot options specified in its UEFI settings, which are controlled by both the instance's UEFI firmware and the guest operating system. Boot options can change as disks are attached and detached, which may result in an instance that only boots to the EFI shell until a boot disk is set.","auto-restart-policy","The auto-restart policy for this instance.\n\nThis policy determines whether the instance should be automatically restarted by the control plane on failure. If this is `null`, any explicitly configured auto-restart policy will be unset, and the control plane will select the default policy when determining whether the instance can be automatically restarted.\n\nCurrently, the global default auto-restart policy is \"best-effort\", so instances with `null` auto-restart policies will be automatically restarted. However, in the future, the default policy may be configurable through other mechanisms, such as on a per-project basis. In that case, any configured default policy will be used if this is `null`.",[2636,2637],"never","best_effort","stop","

Stop instance

\n",[2642,2643,2644],"instance/stop",{"_21":2579,"_23":2604},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"start","

Boot instance

\n",[2649,2650,2651],"instance/start",{"_21":2579,"_23":2604},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Connect to or retrieve data from the instance's serial console.

\n",[2700],[2656,2657],"instance/serial",{"_13":2678,"_15":2679,"_1000":2680,"_17":2681,"_19":2682},{"_13":1393,"_15":2658,"_1000":2659,"_17":2660,"_19":2661},"

Fetch an instance's serial console output.

\n","

Fetch an instance's serial console output.

(To connect interactively and follow live output, try oxide instance serial console)

\n",[2662,2663,2664,2665,2666,2667],"instance/serial/history",{"_521":2675,"_21":2676,"_23":2677},{"_521":2674,"_21":2579,"_23":2604},{"_521":2671,"_21":2672,"_23":2673},{"_521":2668,"_21":2669,"_23":2670},{"_21":22,"_23":24,"_25":26},{"_521":522,"_21":98,"_23":99},"m","max-bytes","Maximum number of bytes of buffered serial console contents to return. If the requested range (starting at --byte-offset) runs to the end of the available buffer, the data returned will be shorter (and if --json is provided, the actual final offset will be provided)","j","json","Output a JSON payload of the requested bytes, and the absolute byte-offset-since-boot of the last byte retrieved, rather than formatting the output to the terminal directly","i","b","byte-offset","The offset since boot (or if negative, the current end of the buffered data) from which to retrieve output history. Defaults to the instance's first output from boot","console","

Connect to an instance's serial console interactively.

\n","

Connect to an instance's serial console interactively.

(To pull output non-interactively, try oxide instance serial history)

\n",[2683,2684,2685,2686,2687,2688,2689],"instance/serial/console",{"_21":2698,"_23":2699},{"_521":2695,"_21":2696,"_23":2697},{"_521":2674,"_21":2579,"_23":2604},{"_521":2668,"_21":2693,"_23":2694},{"_21":22,"_23":24,"_25":26},{"_521":522,"_21":98,"_23":99},{"_521":2690,"_21":2691,"_23":2692},"t","tty","Use a specified tty device (e.g. /dev/ttyUSB0) rather than the current terminal's stdin/stdout","most-recent","The number of bytes from the most recent output to retrieve as context before connecting to the interactive session directly","e","escape-string","If this sequence of bytes is typed, the client will exit. Note that the string passed for this argument must be valid UTF-8, and is used verbatim without any parsing; in most shells, if you wish to include a special character (such as Enter or a Ctrl+letter combo), you can insert the character by preceding it with Ctrl+V at the command line. To disable the escape string altogether, provide an empty string to this flag (and to exit in such a case, use pkill or similar).\n\n[default: { Ctrl+], Ctrl+C }]\n-- which would appear in your shell as ^]^C if you provided it manually by typing { Ctrl+V, Ctrl+], Ctrl+V, Ctrl+C } at the command line.","escape-prefix-length","The number of bytes from the beginning of the escape string to pass to the VM before beginning to buffer inputs until a mismatch. Defaults to 0, such that input matching the escape string does not get sent to the VM at all until a non-matching character is typed. For example, to mimic the escape sequence for exiting SSH (\"\\n~.\"), you may pass `-e '^M~.' --escape-prefix-length=1` such that newline gets sent to the VM immediately while still continuing to match the rest of the sequence",{"_21":22,"_23":24,"_25":26},"reboot","

Reboot instance

\n",[2705,2706,2707],"instance/reboot",{"_21":2579,"_23":2604},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"property",[2745],[2712,2713,2714],"instance/property",{"_13":2735,"_15":2736,"_17":2737,"_19":2738},{"_13":2725,"_15":2726,"_17":2727,"_19":2728},{"_13":2715,"_15":2716,"_17":2717,"_19":2718},"ssh-key","

List SSH public keys for instance

List SSH public keys injected via cloud-init during instance creation. Note that this list is a snapshot in time and will not reflect updates made after the instance is created.

\n",[2719,2720,2721,2722,2723],"instance/property/ssh-key",{"_21":2579,"_23":2604},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":2724},[169,170,171],"anti-affinity","

List anti-affinity groups containing instance

\n",[2729,2730,2731,2732,2733],"instance/property/anti-affinity",{"_21":2579,"_23":2604},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":2734},[169,170,171],"affinity","

List affinity groups containing instance

\n",[2739,2740,2741,2742,2743],"instance/property/affinity",{"_21":2579,"_23":2604},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":2744},[169,170,171],{"_21":22,"_23":24,"_25":26},[2810],[2749,2750,2751,2752,2753],"instance/nic",{"_13":192,"_15":2794,"_17":2795,"_19":2796},{"_13":184,"_15":2787,"_17":2788,"_19":2789},{"_13":156,"_15":157,"_17":2779,"_19":2780},{"_13":100,"_15":2764,"_17":2765,"_19":2766},{"_13":90,"_15":2754,"_17":2755,"_19":2756},"

Fetch network interface

\n",[2757,2758,2759,2760],"instance/nic/view",{"_21":2579,"_23":2604},{"_21":2762,"_23":2763},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":2761},"Name or ID of the project, only required if `instance` is provided as a `Name`","interface","Name or ID of the network interface","

Update network interface

\n",[2767,2768,2769,2770,2771,2772,2773,2774,2775],"instance/nic/update",{"_21":117},{"_21":2579,"_23":2604},{"_21":2762,"_23":2763},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":2776,"_23":2777,"_167":2778},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":2761},"primary","Make a secondary interface the instance's primary interface.\n\nIf applied to a secondary interface, that interface will become the primary on the next reboot of the instance. Note that this may have implications for routing between instances, as the new primary interface will be on a distinct subnet from the previous primary interface.\n\nNote that this can only be used to select a new primary interface for an instance. Requests to change the primary interface into a secondary will return an error.",[677,678],[2781,2782,2783,2784,2785],"instance/nic/list",{"_21":2579,"_23":2604},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":2761},{"_21":166,"_167":2786},[169,170,171],"

Delete network interface

Note that the primary interface for an instance cannot be deleted if there are any secondary interfaces. A new primary interface must be designated first. The primary interface can be deleted if there are no secondary interfaces.

\n",[2790,2791,2792,2793],"instance/nic/delete",{"_21":2579,"_23":2604},{"_21":2762,"_23":2763},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":2761},"

Create network interface

\n",[2797,2798,2799,2800,2801,2802,2803,2804,2805],"instance/nic/create",{"_21":117},{"_21":2579,"_23":2604},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":2761},{"_21":2808,"_23":2809},{"_21":2806,"_23":2807},"vpc-name","The VPC in which to create the interface.","subnet-name","The VPC Subnet in which to create the interface.",{"_21":22,"_23":24,"_25":26},"

List instances

\n",[2814,2815,2816,2817],"instance/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":2818},[169,170,171],"from-image","

Launch an instance from a disk image.

\n",[2823,2824,2825,2826,2827,2828,2829,2830,2831,2832,2833,2834],"instance/from-image",{"_21":2848,"_23":2849},{"_21":2625,"_23":2847},{"_21":117,"_23":2846},{"_21":2844,"_23":2845},{"_21":2842,"_23":2843},{"_21":2132,"_23":2841},{"_21":13,"_23":2840},{"_21":2619,"_23":2839},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":2838},{"_21":2836,"_23":2837},{"_21":2645,"_23":2835},"Start the instance immediately","size","Boot disk size; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib","Project for image and instance","Number of vCPUs to be allocated to the instance","Name of the instance to create","Amount of RAM to be allocated to the instance; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib","image","Source image","hostname","The hostname to be assigned to the instance","Description of the instance","CPU platform to place the instance","anti-affinity-group","Anti-affinity group(s) to add the instance to (may be specified multiple times)","external-subnet",[2861],[2854],"instance/external-subnet",{"_13":156,"_15":2855,"_17":2856,"_19":2857},"

List external subnets attached to instance

\n",[2858,2859,2860],"instance/external-subnet/list",{"_21":2579,"_23":2604},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":22,"_23":24,"_25":26},"external-ip",[2894],[2866,2867,2868],"instance/external-ip",{"_13":2885,"_15":2886,"_17":2887,"_19":2888},{"_13":2875,"_15":2876,"_17":2877,"_19":2878},{"_13":156,"_15":2869,"_17":2870,"_19":2871},"

List external IP addresses

\n",[2872,2873,2874],"instance/external-ip/list",{"_21":2579,"_23":2604},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"detach-ephemeral","

Detach and deallocate ephemeral IP from instance

When an instance has both IPv4 and IPv6 ephemeral IPs, the ip_version query parameter must be specified to identify which IP to detach.

\n",[2879,2880,2881,2882],"instance/external-ip/detach-ephemeral",{"_21":2579,"_23":2604},{"_21":769,"_23":2883,"_167":2884},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"The IP version of the ephemeral IP to detach.\n\nRequired when the instance has both IPv4 and IPv6 ephemeral IPs. If only one ephemeral IP is attached, this field may be omitted.",[772,773],"attach-ephemeral","

Allocate and attach ephemeral IP to instance

\n",[2889,2890,2891,2892,2893],"instance/external-ip/attach-ephemeral",{"_21":2579,"_23":2604},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":22,"_23":24,"_25":26},[2929],[2898,2899,2900],"instance/disk",{"_13":2505,"_15":2920,"_17":2921,"_19":2922},{"_13":2492,"_15":2910,"_17":2911,"_19":2912},{"_13":156,"_15":2901,"_17":2902,"_19":2903},"

List disks for instance

\n",[2904,2905,2906,2907,2908],"instance/disk/list",{"_21":2579,"_23":2604},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":2909},[169,170,171],"

Detach disk from instance

\n",[2913,2914,2915,2916,2917,2918],"instance/disk/detach",{"_21":1921,"_23":2919},{"_21":2579,"_23":2604},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"Name or ID of the disk","

Attach disk to instance

\n",[2923,2924,2925,2926,2927,2928],"instance/disk/attach",{"_21":1921,"_23":2919},{"_21":2579,"_23":2604},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":22,"_23":24,"_25":26},"

Delete instance

\n",[2933,2934,2935],"instance/delete",{"_21":2579,"_23":2604},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create instance

\n",[2939,2940,2941,2942,2943,2944,2945,2946,2947,2948,2949,2950,2951,2952],"instance/create",{"_21":2633,"_23":2960,"_167":2961},{"_21":2625,"_23":2626,"_167":2959},{"_21":117},{"_21":2622,"_23":2957,"_167":2958},{"_21":2844,"_23":2845},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":2132,"_23":2621},{"_21":13},{"_21":2619,"_23":2620},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":2645,"_23":2955,"_167":2956},{"_21":2953,"_23":2954},"user-data","User data for instance initialization systems (such as cloud-init). Must be a Base64-encoded string, as specified in RFC 4648 § 4 (+ and / characters with padding). Maximum 32 KiB unencoded data.","Should this instance be started upon creation; true by default.",[677,678],"Enable jumbo frames (8500 byte MTU) on the instance's primary OPTE interface. Requires the fleet-wide jumbo-frames opt-in to be enabled by an operator; otherwise this field must be `false`. Changes only take effect on the next instance restart.",[677,678],[2628,2629,2630],"The auto-restart policy for this instance.\n\nThis policy determines whether the instance should be automatically restarted by the control plane on failure. If this is `null`, no auto-restart policy will be explicitly configured for this instance, and the control plane will select the default policy when determining whether the instance can be automatically restarted.\n\nCurrently, the global default auto-restart policy is \"best-effort\", so instances with `null` auto-restart policies will be automatically restarted. However, in the future, the default policy may be configurable through other mechanisms, such as on a per-project basis. In that case, any configured default policy will be used if this is `null`.",[2636,2637],[3059],[2965,2966,2967,2968,2969,2970],"instance/anti-affinity",{"_13":192,"_15":3043,"_17":3044,"_19":3045},{"_13":184,"_15":3037,"_17":3038,"_19":3039},{"_13":156,"_15":3029,"_17":3030,"_19":3031},{"_13":708,"_17":2988,"_27":2989,"_19":2990},{"_13":100,"_15":2978,"_17":2979,"_19":2980},{"_13":90,"_15":2971,"_17":2972,"_19":2973},"

Fetch anti-affinity group

\n",[2974,2975,2976],"instance/anti-affinity/view",{"_21":2848,"_23":2977},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"Name or ID of the anti affinity group","

Update anti-affinity group

\n",[2981,2982,2983,2984,2985,2986,2987],"instance/anti-affinity/update",{"_21":2848,"_23":2977},{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},[3028],[2991,2992,2993,2994],"instance/anti-affinity/member",{"_13":3020,"_15":3021,"_17":3022,"_19":3023},{"_13":156,"_15":3011,"_17":3012,"_19":3013},{"_13":3003,"_15":3004,"_17":3005,"_19":3006},{"_13":2995,"_15":2996,"_17":2997,"_19":2998},"view-instance","

Fetch anti-affinity group member

\n",[2999,3000,3001,3002],"instance/anti-affinity/member/view-instance",{"_21":2848},{"_21":2579},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"remove-instance","

Remove member from anti-affinity group

\n",[3007,3008,3009,3010],"instance/anti-affinity/member/remove-instance",{"_21":2848},{"_21":2579},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

List anti-affinity group members

\n",[3014,3015,3016,3017,3018],"instance/anti-affinity/member/list",{"_21":2848,"_23":2977},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3019},[169,170,171],"add-instance","

Add member to anti-affinity group

\n",[3024,3025,3026,3027],"instance/anti-affinity/member/add-instance",{"_21":2848},{"_21":2579},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":22,"_23":24,"_25":26},"

List anti-affinity groups

\n",[3032,3033,3034,3035],"instance/anti-affinity/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3036},[169,170,171],"

Delete anti-affinity group

\n",[3040,3041,3042],"instance/anti-affinity/delete",{"_21":2848,"_23":2977},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create anti-affinity group

\n",[3046,3047,3048,3049,3050,3051,3052,3053],"instance/anti-affinity/create",{"_21":117},{"_21":3057,"_167":3058},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":543,"_167":3054},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},[3055,3056],"allow","fail","failure-domain",[1811],{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},[3118],[3063,3064,3065,3066,3067,3068],{"_13":192,"_15":3104,"_17":3105,"_19":3106},{"_13":184,"_15":3098,"_17":3099,"_19":3100},{"_13":3091,"_15":3092,"_17":3093,"_19":3094},{"_13":156,"_15":3083,"_17":3084,"_19":3085},{"_13":3076,"_15":3077,"_17":3078,"_19":3079},{"_13":90,"_15":3069,"_17":3070,"_19":3071},"

Fetch image

Fetch the details for a specific image in a project.

\n",[3072,3073,3074],"image/view",{"_21":2842,"_23":3075},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"Name or ID of the image","promote","

Promote project image

Promote project image to be visible to all projects in the silo

\n",[3080,3081,3082],"image/promote",{"_21":2842,"_23":3075},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

List images

List images which are global or scoped to the specified project. The images are returned sorted by creation date, with the most recent images appearing first.

\n",[3086,3087,3088,3089],"image/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3090},[169,170,171],"demote","

Demote silo image

Demote silo image to be visible only to a specified project

\n",[3095,3096,3097],"image/demote",{"_21":2842,"_23":3075},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Delete image

Permanently delete an image from a project. This operation cannot be undone. Any instances in the project using the image will continue to run, however new instances can not be created with this image.

\n",[3101,3102,3103],"image/delete",{"_21":2842,"_23":3075},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create image

Create a new image in a project.

\n",[3107,3108,3109,3110,3111,3112,3113,3114],"image/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":3116,"_23":3117},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":31,"_23":3115},"The version of the operating system (e.g. 18.04, 20.04, etc.)","os","The family of the operating system (e.g. Debian, Ubuntu, etc.)",{"_21":22,"_23":24,"_25":26},[3129],[3121],{"_13":156,"_15":3122,"_17":3123,"_19":3124},"

List groups

\n",[3125,3126,3127],"group/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3128},[171],{"_21":22,"_23":24,"_25":26},"floating-ip",[3200],[3133,3134,3135,3136,3137,3138,3139],{"_13":2505,"_15":3186,"_17":3187,"_19":3188},{"_13":192,"_15":3177,"_17":3178,"_19":3179},{"_13":184,"_15":3171,"_17":3172,"_19":3173},{"_13":2492,"_15":3165,"_17":3166,"_19":3167},{"_13":156,"_15":3157,"_17":3158,"_19":3159},{"_13":100,"_15":3147,"_17":3148,"_19":3149},{"_13":90,"_15":3140,"_17":3141,"_19":3142},"

Fetch floating IP

\n",[3143,3144,3145],"floating-ip/view",{"_21":3130,"_23":3146},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"Name or ID of the floating IP","

Update floating IP

\n",[3150,3151,3152,3153,3154,3155,3156],"floating-ip/update",{"_21":117},{"_21":3130,"_23":3146},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

List floating IPs

\n",[3160,3161,3162,3163],"floating-ip/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3164},[169,170,171],"

Detach floating IP

\n",[3168,3169,3170],"floating-ip/detach",{"_21":3130,"_23":3146},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Delete floating IP

\n",[3174,3175,3176],"floating-ip/delete",{"_21":3130,"_23":3146},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create floating IP

A specific IP address can be reserved, or an IP can be auto-allocated from a specific pool or the silo's default pool.

\n",[3180,3181,3182,3183,3184,3185],"floating-ip/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Attach floating IP

Attach floating IP to an instance or other resource.

\n",[3189,3190,3191,3192,3193,3194,3195],"floating-ip/attach",{"_21":3130,"_23":3146},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":1667,"_23":3198,"_167":3199},{"_21":3196,"_23":3197},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"parent","Name or ID of the resource that this IP address should be attached to","The type of `parent`'s resource",[2579],{"_21":22,"_23":24,"_25":26},[3266],[3203,3204,3205,3206,3207,3208,3209],{"_13":2505,"_15":3256,"_17":3257,"_19":3258},{"_13":192,"_15":3247,"_17":3248,"_19":3249},{"_13":184,"_15":3241,"_17":3242,"_19":3243},{"_13":2492,"_15":3235,"_17":3236,"_19":3237},{"_13":156,"_15":3227,"_17":3228,"_19":3229},{"_13":100,"_15":3217,"_17":3218,"_19":3219},{"_13":90,"_15":3210,"_17":3211,"_19":3212},"

Fetch external subnet

\n",[3213,3214,3215],"external-subnet/view",{"_21":2850,"_23":3216},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"Name or ID of the external subnet","

Update external subnet

\n",[3220,3221,3222,3223,3224,3225,3226],"external-subnet/update",{"_21":117},{"_21":2850,"_23":3216},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

List external subnets

\n",[3230,3231,3232,3233],"external-subnet/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3234},[169,170,171],"

Detach external subnet from instance

\n",[3238,3239,3240],"external-subnet/detach",{"_21":2850,"_23":3216},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Delete external subnet

\n",[3244,3245,3246],"external-subnet/delete",{"_21":2850,"_23":3216},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create external subnet

\n",[3250,3251,3252,3253,3254,3255],"external-subnet/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Attach external subnet to instance

\n",[3259,3260,3261,3262,3263,3264],"external-subnet/attach",{"_21":2850,"_23":3216},{"_21":2579,"_23":3265},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"Name or ID of the instance to attach to",{"_21":22,"_23":24,"_25":26},"experimental",[3541],[3270,3271,3272,3273],{"_13":2579,"_17":3405,"_27":3406,"_19":3407},{"_13":3371,"_17":3372,"_27":3373,"_19":3374},{"_13":434,"_17":3301,"_27":3302,"_19":3303},{"_13":3274,"_17":3275,"_27":3276,"_19":3277},"timeseries",[3300],[3278,3279],"experimental/timeseries",{"_13":3290,"_15":3291,"_17":3292,"_19":3293},{"_13":3280,"_15":3281,"_17":3282,"_19":3283},"query","

Run project-scoped timeseries query

Queries are written in OxQL. Project must be specified by name or ID in URL query parameter. The OxQL query will only return timeseries data from the specified project.

\n",[3284,3285,3286,3287,3288],"experimental/timeseries/query",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":3280,"_23":3289},"A timeseries query string, written in the Oximeter query language.","dashboard","

Graph the results of an OxQL timeseries query.

\n",[3294,3295,3296],"experimental/timeseries/dashboard",{"_521":2674,"_21":3298,"_23":3299},{"_21":22,"_23":24,"_25":26},{"_13":3280,"_23":3297},"The timeseries query to display in the dashboard","interval","The interval on which to update the dashboard display, in seconds",{"_21":22,"_23":24,"_25":26},[3370],[3304,3305],"experimental/system",{"_13":3330,"_17":3331,"_27":3332,"_19":3333},{"_13":3274,"_17":3306,"_27":3307,"_19":3308},[3329],[3309,3310],"experimental/system/timeseries",{"_13":3280,"_15":3322,"_17":3323,"_19":3324},{"_13":3311,"_17":3312,"_27":3313,"_19":3314},"schema",[3321],[3315],"experimental/system/timeseries/schema",{"_13":156,"_15":3316,"_17":3317,"_19":3318},"

List timeseries schemas

\n",[3319,3320],"experimental/system/timeseries/schema/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"

Run timeseries query

Queries are written in OxQL.

\n",[3325,3326,3327,3328],"experimental/system/timeseries/query",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":3280,"_23":3289},{"_21":22,"_23":24,"_25":26},"probe",[3369],[3334,3335,3336,3337],"experimental/system/probe",{"_13":192,"_15":3359,"_17":3360,"_19":3361},{"_13":184,"_15":3353,"_17":3354,"_19":3355},{"_13":156,"_15":3345,"_17":3346,"_19":3347},{"_13":90,"_15":3338,"_17":3339,"_19":3340},"

View instrumentation probe

\n",[3341,3342,3343],"experimental/system/probe/view",{"_21":3330,"_23":3344},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"Name or ID of the probe","

List instrumentation probes

\n",[3348,3349,3350,3351],"experimental/system/probe/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3352},[169,170,171],"

Delete instrumentation probe

\n",[3356,3357,3358],"experimental/system/probe/delete",{"_21":3330,"_23":3344},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create instrumentation probe

\n",[3362,3363,3364,3365,3366,3367,3368],"experimental/system/probe/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":1811},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"multicast-group",[3404],[3375,3376,3377],"experimental/multicast-group",{"_13":156,"_15":3397,"_17":3398,"_19":3399},{"_13":708,"_17":3384,"_27":3385,"_19":3386},{"_13":90,"_15":3378,"_17":3379,"_19":3380},"

Fetch multicast group

The group can be specified by name, UUID, or multicast IP address. (e.g., "224.1.2.3" or "ff38::1").

\n",[3381,3382],"experimental/multicast-group/view",{"_21":3371,"_23":3383},{"_21":22,"_23":24,"_25":26},"Name, ID, or IP address of the multicast group",[3396],[3387],"experimental/multicast-group/member",{"_13":156,"_15":3388,"_17":3389,"_19":3390},"

List members of multicast group

The group can be specified by name, UUID, or multicast IP address.

\n",[3391,3392,3393,3394],"experimental/multicast-group/member/list",{"_21":172,"_23":173},{"_21":3371,"_23":3383},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3395},[171],{"_21":22,"_23":24,"_25":26},"

List multicast groups

\n",[3400,3401,3402],"experimental/multicast-group/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3403},[169,170,171],{"_21":22,"_23":24,"_25":26},[3540],[3408,3409],"experimental/instance",{"_13":2735,"_17":3447,"_27":3448,"_19":3449},{"_13":3371,"_17":3410,"_27":3411,"_19":3412},[3446],[3413,3414,3415],"experimental/instance/multicast-group",{"_13":3433,"_15":3434,"_17":3435,"_19":3436},{"_13":3425,"_15":3426,"_17":3427,"_19":3428},{"_13":156,"_15":3416,"_17":3417,"_19":3418},"

List multicast groups for an instance

\n",[3419,3420,3421,3422,3423],"experimental/instance/multicast-group/list",{"_21":2579,"_23":2604},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3424},[171],"leave","

Leave multicast group by name, IP address, or UUID

\n",[3429,3430,3431,3432],"experimental/instance/multicast-group/leave",{"_21":2579,"_23":2604},{"_21":3371,"_23":3383},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"join","

Join multicast group by name, IP address, or UUID

Groups can be referenced by name, IP address, or UUID. If the group doesn't exist, it's implicitly created with an auto-allocated IP from a multicast pool linked to the caller's silo. When referencing by UUID, the group must already exist.

Source IPs are optional for ASM addresses but required for SSM addresses (232.0.0.0/8 for IPv4, ff3x::/32 for IPv6). Duplicate IPs in the request are automatically deduplicated, with a maximum of 64 source IPs allowed.

\n",[3437,3438,3439,3440,3441,3442,3443],"experimental/instance/multicast-group/join",{"_21":2579,"_23":2604},{"_21":769,"_23":3444,"_167":3445},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":3371,"_23":3383},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"IP version for pool selection when creating a group by name. Required if both IPv4 and IPv6 default multicast pools are linked.",[772,773],{"_21":22,"_23":24,"_25":26},[3539],[3450,3451,3452,3453,3454,3455],"experimental/instance/affinity",{"_13":192,"_15":3526,"_17":3527,"_19":3528},{"_13":184,"_15":3520,"_17":3521,"_19":3522},{"_13":156,"_15":3512,"_17":3513,"_19":3514},{"_13":708,"_17":3474,"_27":3475,"_19":3476},{"_13":100,"_15":3464,"_17":3465,"_19":3466},{"_13":90,"_15":3456,"_17":3457,"_19":3458},"

Fetch affinity group

\n",[3459,3460,3461],"experimental/instance/affinity/view",{"_21":3462,"_23":3463},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"affinity-group","Name or ID of the affinity group","

Update affinity group

\n",[3467,3468,3469,3470,3471,3472,3473],"experimental/instance/affinity/update",{"_21":3462,"_23":3463},{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},[3511],[3477,3478,3479,3480],"experimental/instance/affinity/member",{"_13":3020,"_15":3504,"_17":3505,"_19":3506},{"_13":156,"_15":3495,"_17":3496,"_19":3497},{"_13":3003,"_15":3488,"_17":3489,"_19":3490},{"_13":2995,"_15":3481,"_17":3482,"_19":3483},"

Fetch affinity group member

\n",[3484,3485,3486,3487],"experimental/instance/affinity/member/view-instance",{"_21":3462},{"_21":2579},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Remove member from affinity group

\n",[3491,3492,3493,3494],"experimental/instance/affinity/member/remove-instance",{"_21":3462},{"_21":2579},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

List affinity group members

\n",[3498,3499,3500,3501,3502],"experimental/instance/affinity/member/list",{"_21":3462,"_23":3463},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3503},[169,170,171],"

Add member to affinity group

\n",[3507,3508,3509,3510],"experimental/instance/affinity/member/add-instance",{"_21":3462},{"_21":2579},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":22,"_23":24,"_25":26},"

List affinity groups

\n",[3515,3516,3517,3518],"experimental/instance/affinity/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3519},[169,170,171],"

Delete affinity group

\n",[3523,3524,3525],"experimental/instance/affinity/delete",{"_21":3462,"_23":3463},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create affinity group

\n",[3529,3530,3531,3532,3533,3534,3535,3536],"experimental/instance/affinity/create",{"_21":117},{"_21":3057,"_167":3538},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":543,"_167":3537},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},[3055,3056],[1811],{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"docs","

List all CLI commands

\n",[3545,3546],{"_21":3547,"_23":3548,"_167":3549},{"_21":22,"_23":24,"_25":26},"format","Output format",[3550,2672],"text",[3665],[3553,3554,3555,3556,3557],{"_13":192,"_15":3654,"_17":3655,"_19":3656},{"_13":184,"_15":3648,"_17":3649,"_19":3650},{"_13":1423,"_15":3572,"_1000":3573,"_17":3574,"_27":3575,"_19":3576},{"_13":156,"_15":3564,"_17":3565,"_19":3566},{"_13":90,"_15":3558,"_17":3559,"_19":3560},"

Fetch disk

\n",[3561,3562,3563],"disk/view",{"_21":1921,"_23":2919},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

List disks

\n",[3567,3568,3569,3570],"disk/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":166,"_167":3571},[169,170,171],"

Create a disk from a file upload

\n","

Create a disk from a file upload

Create a new disk and upload the contents of a file to that disk. Use\n--snapshot to optionally create a snapshot of the disk after the upload is\ncomplete. If creating a snapshot, optionally use the --image options to\ncreate an image from that snapshot.

The start, write, stop, and finalize subcommands can be used for lower-\nlevel operations.

\n",[3618,3619,3620,3621,3622,3623,3624,3625,3626,3627,3628,3629],[3577,3578,3579,3580],"disk/import",{"_13":3606,"_15":3607,"_17":3608,"_19":3609},{"_13":2645,"_15":3600,"_17":3601,"_19":3602},{"_13":2638,"_15":3594,"_17":3595,"_19":3596},{"_13":3581,"_15":3582,"_17":3583,"_19":3584},"write","

Import blocks into disk

\n",[3585,3586,3587,3588,3589,3590,3591],"disk/import/write",{"_21":3593},{"_21":1921,"_23":2919},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":3592},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"offset","base64-encoded-data","

Stop importing blocks into disk

Stop the process of importing blocks into a disk

\n",[3597,3598,3599],"disk/import/stop",{"_21":1921,"_23":2919},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Start importing blocks into disk

Start the process of importing blocks into a disk

\n",[3603,3604,3605],"disk/import/start",{"_21":1921,"_23":2919},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"finalize","

Confirm disk block import completion

\n",[3610,3611,3612,3613,3614,3615],"disk/import/finalize",{"_21":1921,"_23":2919},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":3616,"_23":3617},"snapshot-name","If specified a snapshot of the disk will be created with the given name during finalization. If not specified, a snapshot for the disk will _not_ be created. A snapshot can be manually created once the disk transitions into the `Detached` state.",{"_21":117},{"_21":1921,"_23":3647},{"_21":3641,"_23":3642,"_167":3643},{"_21":3639,"_23":3640},{"_21":2842,"_23":3638},{"_21":3636,"_23":3637},{"_21":3634,"_23":3635},{"_21":3632,"_23":3633},{"_21":43,"_23":3631},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":1998,"_23":3630},"If supplied, create a snapshot with the given name","Path to the file to import","image-version","The version of this image (e.g. 11, focal, a9e77e3a, 2023-04-06T14:23:34Z)","image-os","The OS of this image (e.g. Debian)","image-description","The description for the image created out of the snapshot of this disk","If supplied, create an image with the given name. Requires the creation of a snapshot","disk-size","The size of the disk to create. If unspecified, the size of the file will be used, rounded up to the nearest GB; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib","disk-block-size","The desired size of the disk's blocks",[3644,3645,3646],"512","2048","4096","The name of the disk to create","

Delete disk

\n",[3651,3652,3653],"disk/delete",{"_21":1921,"_23":2919},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},"

Create disk

\n",[3657,3658,3659,3660,3661,3662,3663],"disk/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":98,"_23":99},{"_21":2836,"_23":3664},"The total size of the Disk; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib",{"_21":22,"_23":24,"_25":26},"current-user",[3742],[3669,3670,3671,3672],{"_13":3722,"_17":3723,"_27":3724,"_19":3725},{"_13":3714,"_15":3715,"_17":3716,"_19":3717},{"_13":2715,"_17":3677,"_27":3678,"_19":3679},{"_13":90,"_15":3673,"_17":3674,"_19":3675},"

Fetch user for current session

\n",[3676],"current-user/view",{"_21":22,"_23":24,"_25":26},[3713],[3680,3681,3682,3683],"current-user/ssh-key",{"_13":192,"_15":3702,"_17":3703,"_19":3704},{"_13":184,"_15":3697,"_17":3698,"_19":3699},{"_13":156,"_15":3690,"_17":3691,"_19":3692},{"_13":90,"_15":3684,"_17":3685,"_19":3686},"

Fetch SSH public key

Fetch SSH public key associated with the currently authenticated user.

\n",[3687,3688],"current-user/ssh-key/view",{"_21":22,"_23":24,"_25":26},{"_21":2715,"_23":3689},"Name or ID of the SSH key","

List SSH public keys

Lists SSH public keys for the currently authenticated user.

\n",[3693,3694,3695],"current-user/ssh-key/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3696},[169,170,171],"

Delete SSH public key

Delete an SSH public key associated with the currently authenticated user.

\n",[3700,3701],"current-user/ssh-key/delete",{"_21":22,"_23":24,"_25":26},{"_21":2715,"_23":3689},"

Create SSH public key

Create an SSH public key for the currently authenticated user.

\n",[3705,3706,3707,3708,3709,3710],"current-user/ssh-key/create",{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":3711,"_23":3712},"public-key","SSH public key, e.g., `\"ssh-ed25519 AAAAC3NzaC...\"`",{"_21":22,"_23":24,"_25":26},"groups","

Fetch current user's groups

\n",[3718,3719,3720],"current-user/groups",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3721},[171],"access-token",[3741],[3726,3727],"current-user/access-token",{"_13":184,"_15":3735,"_17":3736,"_19":3737},{"_13":156,"_15":3728,"_17":3729,"_19":3730},"

List access tokens

List device access tokens for the currently authenticated user.

\n",[3731,3732,3733],"current-user/access-token/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3734},[171],"

Delete access token

Delete a device access token for the currently authenticated user.

\n",[3738,3739],"current-user/access-token/delete",{"_21":22,"_23":24,"_25":26},{"_21":2333,"_23":3740},"ID of the token",{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"completion","

Generate shell completion scripts for Oxide CLI commands.

\n","

Generate shell completion scripts for Oxide CLI commands.

This command generates scripts for various shells that can be used to\nenable completion.

Installation

Bash

Add this to your ~/.bash_profile:

eval "$(oxide completion -s bash)"\n

Zsh

Add this to your ~/.zshrc:

autoload -U compinit\ncompinit -i\neval "$(oxide completion -s zsh)"\n

Fish

Add the following to the is-interactive block in your ~/.config/fish/config.fish:

oxide completion -s fish | source\n

PowerShell

Open your profile script with:

mkdir -Path (Split-Path -Parent $profile)\nnotepad $profile\n

Add the following line and save the file:

Invoke-Expression -Command $(oxide completion -s powershell | Out-String)\n

Elvish

Add this to your ~/.config/elvish/rc.elv

eval (oxide completion -s elvish | slurp)\n

\n",[3747,3748],{"_21":22,"_23":24,"_25":26},{"_521":3749,"_21":3750,"_23":3751,"_167":3752},"s","shell","Shell type",[3753,3754,3755,3756,3757],"bash","elvish","fish","powershell","zsh","certificate",[3802],[3761,3762,3763,3764],{"_13":192,"_15":3783,"_17":3784,"_19":3785},{"_13":184,"_15":3778,"_17":3779,"_19":3780},{"_13":156,"_15":3771,"_17":3772,"_19":3773},{"_13":90,"_15":3765,"_17":3766,"_19":3767},"

Fetch certificate

Returns the details of a specific certificate

\n",[3768,3769],"certificate/view",{"_21":3758,"_23":3770},{"_21":22,"_23":24,"_25":26},"Name or ID of the certificate","

List certificates for external endpoints

Returns a list of TLS certificates used for the external API (for the current Silo). These are sorted by creation date, with the most recent certificates appearing first.

\n",[3774,3775,3776],"certificate/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3777},[169,170,171],"

Delete certificate

Permanently delete a certificate. This operation cannot be undone.

\n",[3781,3782],"certificate/delete",{"_21":3758,"_23":3770},{"_21":22,"_23":24,"_25":26},"

Create system-wide x.509 certificate

This certificate is automatically used by the Oxide Control plane to serve external connections.

\n",[3786,3787,3788,3789,3790,3791,3792,3793],"certificate/create",{"_21":3800,"_23":3801},{"_21":117},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":3798,"_23":3799},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":3794,"_23":3795,"_167":3796},"service","The service using this certificate",[3797],"external_api","key","path to a PEM-formatted file containing a private key","cert","path to a PEM-formatted file containing a public certificate chain",{"_21":22,"_23":24,"_25":26},"bundle",[3876],[3806,3807,3808,3809,3810,3811,3812],{"_13":192,"_15":3869,"_17":3870,"_19":3871},{"_13":184,"_15":3864,"_17":3865,"_19":3866},{"_13":3849,"_15":3850,"_17":3851,"_19":3852},{"_13":3839,"_15":3840,"_1000":3841,"_17":3842,"_19":3843},{"_13":156,"_15":3830,"_17":3831,"_19":3832},{"_13":100,"_15":3820,"_17":3821,"_19":3822},{"_13":90,"_15":3813,"_17":3814,"_19":3815},"

View support bundle

\n",[3816,3817],"bundle/view",{"_21":3818,"_23":3819},{"_21":22,"_23":24,"_25":26},"bundle-id","ID of the support bundle","

Update support bundle

\n",[3823,3824,3825,3826,3827],"bundle/update",{"_21":3818,"_23":3819},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":3828,"_23":3829},"user-comment","User comment for the support bundle","

List all support bundles

\n",[3833,3834,3835],"bundle/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3836},[3837,3838],"time_and_id_ascending","time_and_id_descending","inspect","

Inspects a support bundle

\n","

Inspects a support bundle

Support bundles may be inspected before they are downloaded (via\nsmaller HTTP requests), or after the entire zip file has been\ndownloaded.

\n",[3844,3845,3846],"bundle/inspect",{"_21":979,"_23":3848},{"_521":522,"_21":43,"_23":3847},{"_21":22,"_23":24,"_25":26},"Path of the bundle to inspect, if downloaded","ID of the bundle to be inspected, if accessing via API","download","

Downloads a support bundle

\n",[3853,3854,3855,3856],"bundle/download",{"_521":3861,"_21":3862,"_23":3863},{"_21":979,"_23":3860},{"_521":3857,"_21":3858,"_23":3859},{"_21":22,"_23":24,"_25":26},"o","output","Path where the bundle should be downloaded","ID of the bundle","c","chunk-size","The size, in bytes, of each range request to use when downloading bundles","

Delete support bundle

May also be used to cancel a support bundle which is currently being collected, or to remove metadata for a support bundle that has failed.

\n",[3867,3868],"bundle/delete",{"_21":3818,"_23":3819},{"_21":22,"_23":24,"_25":26},"

Create support bundle

\n",[3872,3873,3874,3875],"bundle/create",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":3828,"_23":3829},{"_21":22,"_23":24,"_25":26},"auth-settings",[3895],[3880,3881],{"_13":100,"_15":3886,"_17":3887,"_19":3888},{"_13":90,"_15":3882,"_17":3883,"_19":3884},"

Fetch current silo's auth settings

\n",[3885],"auth-settings/view",{"_21":22,"_23":24,"_25":26},"

Update current silo's auth settings

\n",[3889,3890,3891,3892],"auth-settings/update",{"_21":3893,"_23":3894},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},"device-token-max-ttl-seconds","Maximum lifetime of a device token in seconds. If set to null, users will be able to create tokens that do not expire.",{"_21":22,"_23":24,"_25":26},"

\n","

Manage oxide's authentication state.

\n",[3940],[3900,3901,3902],{"_13":3921,"_15":3922,"_1000":3923,"_17":3924,"_19":3925},{"_13":400,"_15":3908,"_1000":3909,"_17":3910,"_19":3911},{"_13":498,"_15":3903,"_1000":3904,"_17":3905,"_19":3906},"

Verifies and displays information about your authentication state.

\n","

Verifies and displays information about your authentication state.

This command validates the authentication state for each profile in the\ncurrent configuration.

\n",[3907],"auth/status",{"_21":22,"_23":24,"_25":26},"

Removes saved authentication information from profiles.

\n","

Removes saved authentication information from profiles.

This command does not invalidate any tokens.

\n",[3912,3913,3914],"auth/logout",{"_521":3918,"_21":3919,"_23":3920},{"_521":3915,"_21":3916,"_23":3917},{"_21":22,"_23":24,"_25":26},"f","force","Skip confirmation prompt","a","all","If set, authentication information from all profiles will be deleted","login","

Authenticate with an Oxide Silo

\n","

Authenticate with an Oxide Silo

# authenticate with a specific Oxide silo\n$ oxide auth login --host oxide.internal\n\n# authenticate with an insecure Oxide silo (not recommended)\n$ oxide --insecure auth login --host oxide.internal\n

\n",[3926,3927,3928,3929,3930],"auth/login",{"_21":3938,"_23":3939},{"_521":3935,"_21":3936,"_23":3937},{"_21":3933,"_23":3934},{"_21":22,"_23":24,"_25":26},{"_21":3931,"_23":3932},"time-to-live","Lifetime of login. If not specified, the silo's policy is used. Specify units e.g. 7d, 2w, 6M, 1y","no-browser","Print the authentication URL rather than opening a browser window","H","host","The host of the Oxide instance to authenticate with. This assumes https; specify an `http://` prefix if needed","browser","Override the default browser when opening the authentication URL",{"_21":22,"_23":24,"_25":26},"audit-log",[3958],[3944],{"_13":156,"_15":3945,"_17":3946,"_19":3947},"

View audit log

A single item in the audit log represents both the beginning and end of the logged operation (represented by time_started and time_completed) so that clients do not have to find multiple entries and match them up by request ID to get the full picture of an operation. Because timestamps may not be unique, entries have also have a unique id that can be used to deduplicate items fetched from overlapping time intervals.

Audit log entries are designed to be immutable: once you see an entry, fetching it again will never get you a different result. The list is ordered by time_completed, not time_started. If you fetch the audit log for a time range that is fully in the past, the resulting list is guaranteed to be complete, i.e., fetching the same timespan again later will always produce the same set of entries.

\n",[3948,3949,3950,3951,3952],"audit-log/list",{"_21":3956,"_23":3957},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":3955},{"_21":3953,"_23":3954},"start-time","Required, inclusive",[3837,3838],"end-time","Exclusive",{"_21":22,"_23":24,"_25":26},"api","

Makes an authenticated HTTP request to the Oxide API and prints the response.

\n","

Makes an authenticated HTTP request to the Oxide API and prints the response.

The endpoint argument should be a path of a Oxide API endpoint.

The default HTTP request method is "GET" normally and "POST" if any\nparameters were added. Override the method with --method.

Pass one or more -f/--raw-field values in "key=value" format to add\nstatic string parameters to the request payload. To add non-string or\notherwise dynamic values, see --field below. Note that adding request\nparameters will automatically switch the request method to POST. To send\nthe parameters as a GET query string instead, use --method GET.

The -F/--field flag has magic type conversion based on the format of the\nvalue:

literal values "true", "false", "null", and integer/float numbers get\nconverted to appropriate JSON types;
if the value starts with "@", the rest of the value is interpreted as a\nfilename to read the value from. Pass "-" to read from standard input.

Raw request body may be passed from the outside via a file specified by\n--input. Pass "-" to read from standard input. In this mode, parameters\nspecified via --field flags are serialized into URL query parameters.

In --paginate mode, all pages of results will sequentially be requested\nuntil there are no more pages of results.

\n",[3963,3964,3965,3966,3967,3968,3969,3970,3971,3972],{"_521":3989,"_21":3990,"_23":3991},{"_521":3935,"_21":3987,"_23":3988},{"_521":2674,"_21":3985,"_23":3986},{"_21":3983,"_23":3984},{"_21":172,"_23":3982},{"_521":3979,"_21":3980,"_23":3981},{"_21":3977,"_23":3978},{"_21":22,"_23":24,"_25":26},{"_521":3915,"_21":3975,"_23":3976},{"_13":3973,"_23":3974},"endpoint","The endpoint to request","raw-field","Add a string parameter in key=value format","paginate","Make additional HTTP requests to fetch all pages of results","X","method","The HTTP method for the request","Limit the number of paginated items retrieved","input","The file to use as body for the HTTP request (use \"-\" to read from standard input)","include","Include HTTP response headers in the output","header","Add a HTTP request header in `key:value` format","F","field","Add a typed parameter in key=value format","alert",[4156],[3995,3996],{"_13":4143,"_17":4144,"_27":4145,"_19":4146},{"_13":3997,"_17":3998,"_27":3999,"_19":4000},"receiver",[4142],[4001,4002,4003,4004,4005,4006,4007,4008,4009],"alert/receiver",{"_13":184,"_15":4137,"_17":4138,"_19":4139},{"_13":156,"_15":4130,"_17":4131,"_19":4132},{"_13":4109,"_15":4110,"_17":4111,"_19":4112},{"_13":3330,"_15":4101,"_17":4102,"_19":4103},{"_13":4092,"_15":4093,"_17":4094,"_19":4095},{"_13":4082,"_15":4083,"_17":4084,"_19":4085},{"_13":4073,"_15":4074,"_17":4075,"_19":4076},{"_13":90,"_15":4068,"_17":4069,"_19":4070},{"_13":4010,"_17":4011,"_27":4012,"_19":4013},"webhook",[4067],[4014,4015,4016],"alert/receiver/webhook",{"_13":192,"_15":4058,"_17":4059,"_19":4060},{"_13":4029,"_17":4030,"_27":4031,"_19":4032},{"_13":100,"_15":4017,"_17":4018,"_19":4019},"

Update webhook receiver

Note that receiver secrets are NOT added or removed using this endpoint. Instead, use the /v1/webhooks/{secrets}/?receiver={receiver} endpoint to add and remove secrets.

\n",[4020,4021,4022,4023,4024,4025,4026],"alert/receiver/webhook/update",{"_21":117},{"_21":3973,"_23":4028},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},"The name or ID of the webhook receiver.","The URL that webhook notification requests should be sent to","secret",[4057],[4033,4034,4035],"alert/receiver/webhook/secret",{"_13":731,"_15":4048,"_17":4049,"_19":4050},{"_13":184,"_15":4041,"_17":4042,"_19":4043},{"_13":156,"_15":4036,"_17":4037,"_19":4038},"

List webhook receiver secret IDs

\n",[4039,4040],"alert/receiver/webhook/secret/list",{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},"

Remove secret from webhook receiver

\n",[4044,4045],"alert/receiver/webhook/secret/delete",{"_21":22,"_23":24,"_25":26},{"_21":4046,"_23":4047},"secret-id","ID of the secret.","

Add secret to webhook receiver

\n",[4051,4052,4053,4054,4055],"alert/receiver/webhook/secret/add",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},{"_21":4029,"_23":4056},"The value of the shared secret key.",{"_21":22,"_23":24,"_25":26},"

Create webhook receiver

\n",[4061,4062,4063,4064,4065,4066],"alert/receiver/webhook/create",{"_21":117},{"_21":3973,"_23":4028},{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":13},{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"

Fetch alert receiver

\n",[4071,4072],"alert/receiver/view",{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},"unsubscribe","

Remove alert receiver subscription

\n",[4077,4078,4079],"alert/receiver/unsubscribe",{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},{"_21":4080,"_23":4081},"subscription","The event class subscription itself.","subscribe","

Add alert receiver subscription

\n",[4086,4087,4088,4089,4090],"alert/receiver/subscribe",{"_21":114,"_23":115},{"_21":112,"_23":113},{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},{"_21":4080,"_23":4091},"The event class pattern to subscribe to.","resend","

Request re-delivery of alert

\n",[4096,4097,4098],"alert/receiver/resend",{"_21":4099,"_23":4100},{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},"alert-id","UUID of the alert","

Send liveness probe to alert receiver

This endpoint synchronously sends a liveness probe to the selected alert receiver. The response message describes the outcome of the probe: either the successful response (as appropriate), or indication of why the probe failed.

The result of the probe is represented as an AlertDelivery model. Details relating to the status of the probe depend on the alert delivery mechanism, and are included in the AlertDeliveryAttempts model. For example, webhook receiver liveness probes include the HTTP status code returned by the receiver endpoint.

Note that the response status is 200 OK as long as a probe request was able to be sent to the receiver endpoint. If an HTTP-based receiver, such as a webhook, responds to the another status code, including an error, this will be indicated by the response body, not the status of the response.

The resend query parameter can be used to request re-delivery of failed events if the liveness probe succeeds. If it is set to true and the liveness probe succeeds, any alerts for which delivery to this receiver has failed will be queued for re-delivery.

\n",[4104,4105,4106],"alert/receiver/probe",{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},{"_21":4092,"_23":4107,"_167":4108},"If true, resend all events that have not been delivered successfully if the probe request succeeds.",[677,678],"log","

List delivery attempts to alert receiver

Optional query parameters to this endpoint may be used to filter deliveries by state. If none of the failed, pending or delivered query parameters are present, all deliveries are returned. If one or more of these parameters are provided, only those which are set to "true" are included in the response.

\n",[4113,4114,4115,4116,4117,4118,4119],"alert/receiver/log",{"_21":4127,"_23":4128,"_167":4129},{"_21":4124,"_23":4125,"_167":4126},{"_21":172,"_23":173},{"_21":4121,"_23":4122,"_167":4123},{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},{"_21":166,"_167":4120},[3837,3838],"pending","If true, include deliveries which are currently in progress.\n\nIf any of the \"pending\", \"failed\", or \"delivered\" query parameters are set to true, only deliveries matching those state(s) will be included in the response. If NO state filter parameters are set, then all deliveries are included.\n\nA delivery is considered \"pending\" if it has not yet been sent at all, or if a delivery attempt has failed but the delivery has retries remaining.",[677,678],"failed","If true, include deliveries which have failed permanently.\n\nIf any of the \"pending\", \"failed\", or \"delivered\" query parameters are set to true, only deliveries matching those state(s) will be included in the response. If NO state filter parameters are set, then all deliveries are included.\n\nA delivery fails permanently when the retry limit of three total attempts is reached without a successful delivery.",[677,678],"delivered","If true, include deliveries which have succeeded.\n\nIf any of the \"pending\", \"failed\", or \"delivered\" query parameters are set to true, only deliveries matching those state(s) will be included in the response. If NO state filter parameters are set, then all deliveries are included.",[677,678],"

List alert receivers

\n",[4133,4134,4135],"alert/receiver/list",{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},{"_21":166,"_167":4136},[169,170,171],"

Delete alert receiver

\n",[4140,4141],"alert/receiver/delete",{"_21":22,"_23":24,"_25":26},{"_21":3997,"_23":4027},{"_21":22,"_23":24,"_25":26},"class",[4155],[4147],"alert/class",{"_13":156,"_15":4148,"_17":4149,"_19":4150},"

List alert classes

\n",[4151,4152,4153],"alert/class/list",{"_21":1399,"_23":4154},{"_21":172,"_23":173},{"_21":22,"_23":24,"_25":26},"An optional glob pattern for filtering alert class names.\n\nIf provided, only alert classes which match this glob pattern will be included in the response.",{"_21":22,"_23":24,"_25":26},{"_21":22,"_23":24,"_25":26},"methodPreviews",{"_4803":4804,"_4805":4806,"_4807":4808,"_4809":4810,"_4811":4812,"_4813":4814,"_4815":4816,"_4817":4818,"_4819":4820,"_4821":4822,"_4823":4824,"_4825":4826,"_4827":4828,"_4829":4830,"_4831":4832,"_4833":4834,"_4835":4836,"_4837":4838,"_4839":4840,"_4841":4842,"_4843":4844,"_4845":4846,"_4847":4848,"_4849":4850,"_4851":4852,"_4853":4854,"_4855":4856,"_4857":4858,"_4859":4860,"_4861":4862,"_4863":4864,"_4865":4866,"_4867":4868,"_4869":4870,"_4871":4872,"_4873":4874,"_4875":4876,"_4877":4878,"_4879":4880,"_4881":4882,"_4883":4884,"_4885":4886,"_4887":4888,"_4889":4890,"_4891":4892,"_4893":4894,"_4895":4896,"_4897":4898,"_4899":4900,"_4901":4902,"_4903":4904,"_4905":4906,"_4907":4908,"_4909":4910,"_4911":4912,"_4913":4914,"_4915":4916,"_4917":4918,"_4919":4920,"_4921":4922,"_4923":4924,"_4925":4926,"_4927":4928,"_4929":4930,"_4931":4932,"_4933":4934,"_4935":4936,"_4937":4938,"_4939":4940,"_4941":4942,"_4943":4944,"_4945":4946,"_4947":4948,"_4949":4950,"_4951":4952,"_4953":4954,"_4955":4956,"_4957":4958,"_4959":4960,"_4961":4962,"_4963":4964,"_4965":4966,"_4967":4968,"_4969":4970,"_4971":4972,"_4973":4974,"_4975":4976,"_4977":4978,"_4979":4980,"_4981":4982,"_4983":4984,"_4985":4986,"_4987":4988,"_4989":4990,"_4991":4992,"_4993":4994,"_4995":4996,"_4997":4998,"_4999":5000,"_5001":5002,"_5003":5004,"_5005":5006,"_5007":5008,"_5009":5010,"_5011":5012,"_5013":5014,"_5015":5016,"_5017":5018,"_5019":5020,"_5021":5022,"_5023":5024,"_5025":5026,"_5027":5028,"_5029":5030,"_5031":5032,"_5033":5034,"_5035":5036,"_5037":5038,"_5039":5040,"_5041":5042,"_5043":5044,"_5045":5046,"_5047":5048,"_5049":5050,"_5051":5052,"_5053":5054,"_5055":5056,"_5057":5058,"_5059":5060,"_5061":5062,"_5063":5064,"_5065":5066,"_5067":5068,"_5069":5070,"_5071":5072,"_5073":5074,"_5075":5076,"_5077":5078,"_5079":5080,"_5081":5082,"_5083":5084,"_5085":5086,"_5087":5088,"_5089":5090,"_5091":5092,"_5093":5094,"_5095":5096,"_5097":5098,"_5099":5100,"_5101":5102,"_5103":5104,"_5105":5106,"_5107":5108,"_5109":5110,"_5111":5112,"_5113":5114,"_5115":5116,"_5117":5118,"_5119":5120,"_5121":5122,"_5123":5124,"_5125":5126,"_5127":5128,"_5129":5130,"_5131":5132,"_5133":5134,"_5135":5136,"_5137":5138,"_5139":5140,"_5141":5142,"_5143":5144,"_5145":5146,"_5147":5148,"_5149":5150,"_5151":5152,"_5153":5154,"_5155":5156,"_5157":5158,"_5159":5160,"_5161":5162,"_5163":5164,"_5165":5166,"_5167":5168,"_5169":5170,"_5171":5172,"_5173":5174,"_5175":5176,"_5177":5178,"_5179":5180,"_5181":5182,"_5183":5184,"_5185":5186,"_5187":5188,"_5189":5190,"_5191":5192,"_5193":5194,"_5195":5196,"_5197":5198,"_5199":5200,"_5201":5202,"_5203":5204,"_5205":5206,"_5207":5208,"_5209":5210,"_5211":5212,"_5213":5214,"_5215":5216,"_5217":5218,"_5219":5220,"_5221":5222,"_5223":5224,"_5225":5226,"_5227":5228,"_5229":5230,"_5231":5232,"_5233":5234,"_5235":5236,"_5237":5238,"_5239":5240,"_5241":5242,"_5243":5244,"_5245":5246,"_5247":5248,"_5249":5250,"_5251":5252,"_5253":5254,"_5255":5256,"_5257":5258,"_5259":5260,"_5261":5262,"_5263":5264,"_5265":5266,"_5267":5268,"_5269":5270,"_5271":5272,"_5273":5274,"_5275":5276,"_5277":5278,"_5279":5280,"_5281":5282,"_5283":5284,"_14":5285,"_5286":5287,"_5288":5289,"_5290":5291,"_5292":5293,"_5294":5295,"_5296":5297,"_5298":5299,"_5300":5301,"_5302":5303,"_5304":5305,"_5306":5307,"_5308":5309,"_5310":5311,"_5312":5313,"_5314":5315,"_5316":5317,"_5318":5319,"_5320":5321,"_5322":5323,"_5324":5325,"_5326":5327,"_5328":5329,"_5330":5331,"_5332":5333,"_5334":5335,"_5336":5337,"_5338":5339,"_5340":5341,"_5342":5343,"_5344":5345,"_5346":5347,"_5348":5349,"_5350":5351,"_5352":5353,"_5354":5355,"_5356":5357,"_5358":5359,"_5360":5361,"_5362":5363,"_5364":5365,"_5366":5367,"_5368":5369,"_5370":5371,"_5372":5373},"cliPreviews",{"_3992":4371,"_4146":4372,"_4150":4373,"_4000":4374,"_4139":4375,"_4132":4376,"_4112":4377,"_4103":4378,"_4095":4379,"_4085":4380,"_4076":4381,"_4070":4382,"_4013":4383,"_4060":4384,"_4032":4385,"_4050":4386,"_4043":4387,"_4038":4388,"_4019":4389,"_3959":4390,"_3941":4391,"_3947":4392,"_1486":4393,"_3925":4394,"_3911":4395,"_3906":4396,"_3877":4397,"_3888":4398,"_3884":4399,"_3803":4400,"_3871":4401,"_3866":4402,"_3852":4403,"_3843":4404,"_3832":4405,"_3822":4406,"_3815":4407,"_3758":4408,"_3785":4409,"_3780":4410,"_3773":4411,"_3767":4412,"_3743":4413,"_3666":4414,"_3725":4415,"_3737":4416,"_3730":4417,"_3717":4418,"_3679":4419,"_3704":4420,"_3699":4421,"_3692":4422,"_3686":4423,"_3675":4424,"_1921":4425,"_3656":4426,"_3650":4427,"_3576":4428,"_3609":4429,"_3602":4430,"_3596":4431,"_3584":4432,"_3566":4433,"_3560":4434,"_3542":4435,"_3267":4436,"_3407":4437,"_3449":4438,"_3528":4439,"_3522":4440,"_3514":4441,"_3476":4442,"_3506":4443,"_3497":4444,"_3490":4445,"_3483":4446,"_3466":4447,"_3458":4448,"_3412":4449,"_3436":4450,"_3428":4451,"_3418":4452,"_3374":4453,"_3399":4454,"_3386":4455,"_3390":4456,"_3380":4457,"_3303":4458,"_3333":4459,"_3361":4460,"_3355":4461,"_3347":4462,"_3340":4463,"_3308":4464,"_3324":4465,"_3314":4466,"_3318":4467,"_3277":4468,"_3293":4469,"_3283":4470,"_2850":4471,"_3258":4472,"_3249":4473,"_3243":4474,"_3237":4475,"_3229":4476,"_3219":4477,"_3212":4478,"_3130":4479,"_3188":4480,"_3179":4481,"_3173":4482,"_3167":4483,"_3159":4484,"_3149":4485,"_3142":4486,"_432":4487,"_3124":4488,"_2842":4489,"_3106":4490,"_3100":4491,"_3094":4492,"_3085":4493,"_3079":4494,"_3071":4495,"_2579":4496,"_2964":4497,"_3045":4498,"_3039":4499,"_3031":4500,"_2990":4501,"_3023":4502,"_3013":4503,"_3006":4504,"_2998":4505,"_2980":4506,"_2973":4507,"_2938":4508,"_2932":4509,"_2897":4510,"_2922":4511,"_2912":4512,"_2903":4513,"_2865":4514,"_2888":4515,"_2878":4516,"_2871":4517,"_2853":4518,"_2857":4519,"_2822":4520,"_2813":4521,"_2748":4522,"_2796":4523,"_2789":4524,"_2780":4525,"_2766":4526,"_2756":4527,"_2711":4528,"_2738":4529,"_2728":4530,"_2718":4531,"_2704":4532,"_2655":4533,"_2682":4534,"_2661":4535,"_2648":4536,"_2641":4537,"_2607":4538,"_2600":4539,"_2447":4540,"_2540":4541,"_2567":4542,"_2556":4543,"_2546":4544,"_2530":4545,"_2521":4546,"_2476":4547,"_2508":4548,"_2495":4549,"_2482":4550,"_2467":4551,"_2458":4552,"_1058":4553,"_2437":4554,"_2433":4555,"_14":4556,"_543":4557,"_2423":4558,"_2419":4559,"_98":4560,"_2406":4561,"_2401":4562,"_2394":4563,"_2376":4564,"_2386":4565,"_2381":4566,"_2367":4567,"_2362":4568,"_2315":4569,"_2322":4570,"_2347":4571,"_2341":4572,"_2336":4573,"_2329":4574,"_656":4575,"_2296":4576,"_2291":4577,"_2185":4578,"_2282":4579,"_2245":4580,"_2249":4581,"_2270":4582,"_2264":4583,"_2256":4584,"_2192":4585,"_2205":4586,"_2197":4587,"_2171":4588,"_2175":4589,"_2164":4590,"_2146":4591,"_2156":4592,"_2151":4593,"_2111":4594,"_2138":4595,"_2122":4596,"_2117":4597,"_2097":4598,"_2101":4599,"_2076":4600,"_2088":4601,"_2081":4602,"_2058":4603,"_2068":4604,"_2063":4605,"_2053":4606,"_1998":4607,"_2028":4608,"_2022":4609,"_2014":4610,"_2007":4611,"_623":4612,"_1992":4613,"_1988":4614,"_434":4615,"_1731":4616,"_1924":4617,"_1975":4618,"_1967":4619,"_1954":4620,"_1946":4621,"_1941":4622,"_1933":4623,"_1876":4624,"_1915":4625,"_1889":4626,"_1909":4627,"_1901":4628,"_1895":4629,"_1882":4630,"_1814":4631,"_1867":4632,"_1858":4633,"_1850":4634,"_1845":4635,"_1831":4636,"_1823":4637,"_1793":4638,"_1805":4639,"_1798":4640,"_1740":4641,"_1780":4642,"_1771":4643,"_1760":4644,"_1756":4645,"_1748":4646,"_563":4647,"_1689":4648,"_1708":4649,"_1694":4650,"_1634":4651,"_1674":4652,"_1678":4653,"_1660":4654,"_1655":4655,"_1648":4656,"_1642":4657,"_1614":4658,"_1623":4659,"_1619":4660,"_1562":4661,"_1601":4662,"_1573":4663,"_1568":4664,"_1244":4665,"_1549":4666,"_1517":4667,"_1541":4668,"_1531":4669,"_1523":4670,"_1506":4671,"_1510":4672,"_1490":4673,"_1435":4674,"_1471":4675,"_1466":4676,"_1459":4677,"_1442":4678,"_1430":4679,"_1403":4680,"_1396":4681,"_1388":4682,"_1305":4683,"_1372":4684,"_1310":4685,"_1285":4686,"_1279":4687,"_1273":4688,"_1263":4689,"_1224":4690,"_1233":4691,"_1229":4692,"_1061":4693,"_1213":4694,"_1195":4695,"_1190":4696,"_1171":4697,"_1138":4698,"_1161":4699,"_1155":4700,"_1144":4701,"_1093":4702,"_1125":4703,"_1117":4704,"_1111":4705,"_1100":4706,"_1084":4707,"_1079":4708,"_1073":4709,"_1004":4710,"_1021":4711,"_1009":4712,"_936":4713,"_989":4714,"_953":4715,"_942":4716,"_882":4717,"_911":4718,"_895":4719,"_888":4720,"_799":4721,"_865":4722,"_805":4723,"_778":4724,"_787":4725,"_783":4726,"_626":4727,"_762":4728,"_757":4729,"_750":4730,"_711":4731,"_734":4732,"_727":4733,"_718":4734,"_659":4735,"_697":4736,"_688":4737,"_682":4738,"_666":4739,"_649":4740,"_644":4741,"_637":4742,"_581":4743,"_616":4744,"_611":4745,"_601":4746,"_597":4747,"_589":4748,"_546":4749,"_555":4750,"_551":4751,"_443":4752,"_537":4753,"_506":4754,"_526":4755,"_518":4756,"_512":4757,"_501":4758,"_486":4759,"_490":4760,"_452":4761,"_478":4762,"_473":4763,"_466":4764,"_459":4765,"_385":4766,"_426":4767,"_418":4768,"_409":4769,"_403":4770,"_395":4771,"_381":4772,"_31":4773,"_79":4774,"_366":4775,"_360":4776,"_340":4777,"_351":4778,"_345":4779,"_331":4780,"_215":4781,"_320":4782,"_313":4783,"_304":4784,"_244":4785,"_292":4786,"_284":4787,"_274":4788,"_262":4789,"_252":4790,"_232":4791,"_224":4792,"_121":4793,"_195":4794,"_187":4795,"_177":4796,"_154":4797,"_159":4798,"_139":4799,"_130":4800,"_103":4801,"_93":4802},"guidePreviews",{"_4165":4166,"_4167":4168,"_4169":4170,"_4171":4172,"_4173":4174,"_4175":4176,"_4177":4178,"_4179":4180,"_4181":4182,"_4183":4184,"_4185":4186,"_4187":4188,"_4189":4190,"_4191":4192,"_4193":4194,"_4195":4196,"_4197":4198,"_4199":4200,"_4201":4202,"_4203":4204,"_4205":4206,"_4207":4208,"_4209":4210,"_4211":4212,"_4213":4214,"_4215":4216,"_4217":4218,"_4219":4220,"_4221":4222,"_4223":4224,"_4225":4226,"_4227":4228,"_4229":4230,"_4231":4232,"_4233":4234,"_4235":4236,"_4237":4238,"_4239":4240,"_4241":4242,"_4243":4244,"_4245":4246,"_4247":4248,"_4249":4250,"_4251":4252,"_4253":4254,"_4255":4256,"_4257":4258,"_4259":4260,"_4261":4262,"_4263":4264,"_4265":4266,"_4267":4268,"_4269":4270,"_44":4271,"_4272":4273,"_4274":4275,"_4276":4277,"_4278":4279,"_4280":4281,"_4282":4283,"_4284":4285,"_4286":4287,"_4288":4289,"_4290":4291,"_4292":4293,"_4294":4295,"_4296":4297,"_4298":4299,"_4300":4301,"_4302":4303,"_47":4304},"aiEnabled",false,"/guides/alerts/overview",{"_45":4370,"_117":-7},"/guides/alerts/reliable-receivers",{"_45":4369,"_117":-7},"/guides/alerts/webhooks",{"_45":4368,"_117":-7},"/guides/architecture/control-plane",{"_45":4367,"_117":-7},"/guides/architecture/networking",{"_45":4362,"_117":-7},"/guides/architecture/os-hypervisor-storage",{"_45":4366,"_117":-7},"/guides/architecture/power-shelf-controller",{"_45":4365,"_117":-7},"/guides/architecture/rack-components",{"_45":4364,"_117":-7},"/guides/configuring-access",{"_45":4363,"_117":-7},"/guides/configuring-guest-networking",{"_45":4362,"_117":-7},"/guides/creating-and-sharing-images",{"_45":4361,"_117":-7},"/guides/deploying-workloads",{"_45":4360,"_117":-7},"/guides/facilities/overview",{"_45":4359,"_117":-7},"/guides/facilities/physical-installation",{"_45":4358,"_117":-7},"/guides/facilities/power-connection",{"_45":4357,"_117":-7},"/guides/facilities/site-requirements",{"_45":4356,"_117":-7},"/guides/integrations/cloud-controller-manager",{"_45":4355,"_117":-7},"/guides/integrations/grafana",{"_45":4354,"_117":-7},"/guides/integrations/kubernetes",{"_45":4353,"_117":-7},"/guides/integrations/omni",{"_45":4352,"_117":-7},"/guides/integrations/opentelemetry",{"_45":4351,"_117":-7},"/guides/integrations/packer",{"_45":4350,"_117":-7},"/guides/integrations/rancher",{"_45":4349,"_117":-7},"/guides/integrations/terraform",{"_45":4348,"_117":-7},"/guides/introduction",{"_45":48,"_117":-7},"/guides/key-entities-and-concepts",{"_45":4347,"_117":-7},"/guides/managing-disks-and-snapshots",{"_45":4346,"_117":-7},"/guides/managing-floating-ips",{"_45":4345,"_117":-7},"/guides/managing-instances",{"_45":4344,"_117":-7},"/guides/metrics/oxql-tutorial",{"_45":4343,"_117":-7},"/guides/metrics/timeseries-schemas",{"_45":4342,"_117":-7},"/guides/onboarding-projects",{"_45":4341,"_117":-7},"/guides/operator/audit-log",{"_45":4340,"_117":-7},"/guides/operator/configuring-bfd",{"_45":4339,"_117":-7},"/guides/operator/configuring-bgp",{"_45":4338,"_117":-7},"/guides/operator/duo",{"_45":4337,"_117":-7},"/guides/operator/expanding-connectivity",{"_45":4336,"_117":-7},"/guides/operator/expanding-physical-connectivity",{"_45":4335,"_117":-7},"/guides/operator/faq",{"_45":4334,"_117":-7},"/guides/operator/google-workspace",{"_45":4333,"_117":-7},"/guides/operator/hardware-maintenance",{"_45":4332,"_117":-7},"/guides/operator/identity-providers",{"_45":4331,"_117":-7},"/guides/operator/ip-pool-management",{"_45":4330,"_117":-7},"/guides/operator/jumbo-frames",{"_45":4329,"_117":-7},"/guides/operator/jumpcloud",{"_45":4328,"_117":-7},"/guides/operator/keycloak",{"_45":4327,"_117":-7},"/guides/operator/local-only",{"_45":4326,"_117":-7},"/guides/operator/ms-entra",{"_45":4325,"_117":-7},"/guides/operator/okta-jit",{"_45":4324,"_117":-7},"/guides/operator/okta-scim",{"_45":4323,"_117":-7},"/guides/operator/resource-management",{"_45":4322,"_117":-7},"/guides/operator/silo-management",{"_45":4321,"_117":-7},"/guides/operator/system-update",{"_45":4320,"_117":-7},{"_45":46,"_117":-7},"/guides/quickstart",{"_45":4319,"_117":-7},"/guides/remote-access",{"_45":4318,"_117":-7},"/guides/system/completing-rack-config",{"_45":4317,"_117":-7},"/guides/system/initial-rack-setup",{"_45":4316,"_117":-7},"/guides/system/network-preparations",{"_45":4315,"_117":-7},"/guides/system/rack-installation",{"_45":4314,"_117":-7},"/guides/system/system-setup",{"_45":4313,"_117":-7},"/guides/troubleshooting",{"_45":4312,"_117":-7},"/guides/use-cases/pxe-boot",{"_45":4311,"_117":-7},"/guides/user-settings",{"_45":4310,"_117":-7},"/guides/working-with-windows-vms",{"_45":4309,"_117":-7},"/api/guides/authentication",{"_45":4308,"_117":-7},"/api/guides/introduction",{"_45":48,"_117":-7},"/api/guides/resource-identifiers",{"_45":4307,"_117":-7},"/api/guides/responses",{"_45":4306,"_117":-7},"/api/guides/sdks",{"_45":4305,"_117":-7},{"_45":48,"_117":-7},"SDKs","Responses","Resource Identifiers","Authentication","Windows Instances","User Settings","PXE Boot","Troubleshooting","System Setup Guide","Rack Installation","Network Preparations","Initial Rack Setup","Rack Configuration","Remote Access","Quick Start: Web","System Update","Silos","Resource Management","Okta SCIM v2.0 Integration Example","Okta Integration Example","Microsoft Entra ID (Azure AD) Integration Example","Local User Management Example","Keycloak Integration Example","JumpCloud Integration Example","Jumbo Frames","IP Pools and Subnet Pools","Identity Providers","Hardware Maintenance","Google Workspace Integration Example","FAQ","Expanding Physical Connectivity","Expanding Connectivity","Duo Integration Example","BGP","BFD","Audit Log","Projects","Timeseries Schemas","OxQL Tutorial","Instance Actions","Floating IPs","Disks and Snapshots","Key Concepts","Terraform","Rancher","Packer","OpenTelemetry","Omni","Kubernetes Overview","Grafana","Cloud Controller Manager","Site Requirements","Power Connection","Physical Installation","Facilities Overview","Instances","Images","Networking","Access Control","Rack Components","Power Shelf and Controller","Hypervisor and Storage","Control Plane","Webhooks","Reliable Receivers","Alerts Overview",{"_15":-7},{"_15":-7},{"_15":4148},{"_15":-7},{"_15":4137},{"_15":4130},{"_15":4110},{"_15":4101},{"_15":4093},{"_15":4083},{"_15":4074},{"_15":4068},{"_15":-7},{"_15":4058},{"_15":-7},{"_15":4048},{"_15":4041},{"_15":4036},{"_15":4017},{"_15":3961},{"_15":-7},{"_15":3945},{"_15":3897},{"_15":3923},{"_15":3909},{"_15":3904},{"_15":-7},{"_15":3886},{"_15":3882},{"_15":-7},{"_15":3869},{"_15":3864},{"_15":3850},{"_15":3841},{"_15":3830},{"_15":3820},{"_15":3813},{"_15":-7},{"_15":3783},{"_15":3778},{"_15":3771},{"_15":3765},{"_15":3745},{"_15":-7},{"_15":-7},{"_15":3735},{"_15":3728},{"_15":3715},{"_15":-7},{"_15":3702},{"_15":3697},{"_15":3690},{"_15":3684},{"_15":3673},{"_15":-7},{"_15":3654},{"_15":3648},{"_15":3573},{"_15":3607},{"_15":3600},{"_15":3594},{"_15":3582},{"_15":3564},{"_15":3558},{"_15":3543},{"_15":-7},{"_15":-7},{"_15":-7},{"_15":3526},{"_15":3520},{"_15":3512},{"_15":-7},{"_15":3504},{"_15":3495},{"_15":3488},{"_15":3481},{"_15":3464},{"_15":3456},{"_15":-7},{"_15":3434},{"_15":3426},{"_15":3416},{"_15":-7},{"_15":3397},{"_15":-7},{"_15":3388},{"_15":3378},{"_15":-7},{"_15":-7},{"_15":3359},{"_15":3353},{"_15":3345},{"_15":3338},{"_15":-7},{"_15":3322},{"_15":-7},{"_15":3316},{"_15":-7},{"_15":3291},{"_15":3281},{"_15":-7},{"_15":3256},{"_15":3247},{"_15":3241},{"_15":3235},{"_15":3227},{"_15":3217},{"_15":3210},{"_15":-7},{"_15":3186},{"_15":3177},{"_15":3171},{"_15":3165},{"_15":3157},{"_15":3147},{"_15":3140},{"_15":-7},{"_15":3122},{"_15":-7},{"_15":3104},{"_15":3098},{"_15":3092},{"_15":3083},{"_15":3077},{"_15":3069},{"_15":-7},{"_15":-7},{"_15":3043},{"_15":3037},{"_15":3029},{"_15":-7},{"_15":3021},{"_15":3011},{"_15":3004},{"_15":2996},{"_15":2978},{"_15":2971},{"_15":2936},{"_15":2930},{"_15":-7},{"_15":2920},{"_15":2910},{"_15":2901},{"_15":-7},{"_15":2886},{"_15":2876},{"_15":2869},{"_15":-7},{"_15":2855},{"_15":2820},{"_15":2811},{"_15":-7},{"_15":2794},{"_15":2787},{"_15":157},{"_15":2764},{"_15":2754},{"_15":-7},{"_15":2736},{"_15":2726},{"_15":2716},{"_15":2702},{"_15":2652},{"_15":2680},{"_15":2659},{"_15":2646},{"_15":2639},{"_15":2605},{"_15":2598},{"_15":-7},{"_15":-7},{"_15":2565},{"_15":2554},{"_15":2544},{"_15":2528},{"_15":2519},{"_15":-7},{"_15":2506},{"_15":2493},{"_15":2480},{"_15":2465},{"_15":2456},{"_15":-7},{"_15":1169},{"_15":1071},{"_15":16},{"_15":-7},{"_15":2421},{"_15":2417},{"_15":-7},{"_15":2404},{"_15":2399},{"_15":2392},{"_15":-7},{"_15":2384},{"_15":2379},{"_15":2365},{"_15":2360},{"_15":-7},{"_15":-7},{"_15":2345},{"_15":2339},{"_15":2334},{"_15":2327},{"_15":-7},{"_15":2294},{"_15":2289},{"_15":-7},{"_15":2280},{"_15":-7},{"_15":-7},{"_15":2268},{"_15":2262},{"_15":2254},{"_15":-7},{"_15":2203},{"_15":2195},{"_15":-7},{"_15":2173},{"_15":2162},{"_15":-7},{"_15":2154},{"_15":2149},{"_15":-7},{"_15":2136},{"_15":2120},{"_15":2115},{"_15":-7},{"_15":2099},{"_15":-7},{"_15":2086},{"_15":2079},{"_15":-7},{"_15":2066},{"_15":2061},{"_15":2051},{"_15":-7},{"_15":2026},{"_15":2020},{"_15":2012},{"_15":2005},{"_15":-7},{"_15":748},{"_15":635},{"_15":-7},{"_15":-7},{"_15":-7},{"_15":1973},{"_15":1965},{"_15":1952},{"_15":1944},{"_15":1939},{"_15":1931},{"_15":-7},{"_15":1913},{"_15":-7},{"_15":1907},{"_15":1899},{"_15":1893},{"_15":1880},{"_15":-7},{"_15":1865},{"_15":1856},{"_15":1848},{"_15":1843},{"_15":1829},{"_15":1821},{"_15":-7},{"_15":1803},{"_15":1796},{"_15":-7},{"_15":1778},{"_15":1769},{"_15":1758},{"_15":1754},{"_15":1746},{"_15":-7},{"_15":1686},{"_15":1706},{"_15":1692},{"_15":-7},{"_15":-7},{"_15":1676},{"_15":1658},{"_15":1653},{"_15":1646},{"_15":1640},{"_15":-7},{"_15":1621},{"_15":1617},{"_15":-7},{"_15":1599},{"_15":1571},{"_15":1566},{"_15":-7},{"_15":1547},{"_15":-7},{"_15":1539},{"_15":1529},{"_15":1521},{"_15":-7},{"_15":1508},{"_15":1488},{"_15":-7},{"_15":1469},{"_15":1464},{"_15":1457},{"_15":1440},{"_15":1428},{"_15":1401},{"_15":1394},{"_15":1386},{"_15":1302},{"_15":1370},{"_15":1308},{"_15":1283},{"_15":1277},{"_15":1271},{"_15":1261},{"_15":-7},{"_15":1231},{"_15":1227},{"_15":-7},{"_15":1211},{"_15":1193},{"_15":1188},{"_15":1169},{"_15":-7},{"_15":1159},{"_15":1153},{"_15":1142},{"_15":-7},{"_15":1123},{"_15":1115},{"_15":1109},{"_15":1098},{"_15":1082},{"_15":1077},{"_15":1071},{"_15":1001},{"_15":1019},{"_15":1007},{"_15":-7},{"_15":987},{"_15":951},{"_15":940},{"_15":-7},{"_15":909},{"_15":893},{"_15":886},{"_15":796},{"_15":863},{"_15":803},{"_15":-7},{"_15":785},{"_15":781},{"_15":-7},{"_15":760},{"_15":755},{"_15":748},{"_15":-7},{"_15":732},{"_15":725},{"_15":716},{"_15":-7},{"_15":695},{"_15":686},{"_15":680},{"_15":664},{"_15":647},{"_15":642},{"_15":635},{"_15":-7},{"_15":614},{"_15":609},{"_15":599},{"_15":595},{"_15":587},{"_15":-7},{"_15":553},{"_15":549},{"_15":-7},{"_15":535},{"_15":-7},{"_15":524},{"_15":-7},{"_15":510},{"_15":499},{"_15":-7},{"_15":488},{"_15":-7},{"_15":476},{"_15":471},{"_15":464},{"_15":457},{"_15":-7},{"_15":424},{"_15":416},{"_15":407},{"_15":401},{"_15":393},{"_15":382},{"_15":378},{"_15":-7},{"_15":364},{"_15":358},{"_15":-7},{"_15":349},{"_15":343},{"_15":329},{"_15":-7},{"_15":318},{"_15":311},{"_15":302},{"_15":-7},{"_15":290},{"_15":282},{"_15":272},{"_15":260},{"_15":250},{"_15":230},{"_15":222},{"_15":-7},{"_15":193},{"_15":185},{"_15":175},{"_15":-7},{"_15":157},{"_15":137},{"_15":128},{"_15":101},{"_15":91},"anti_affinity_group_list",{"_5374":5380,"_43":5914,"_5376":5916,"_117":-7},"anti_affinity_group_create",{"_5374":5382,"_43":5914,"_5376":5915,"_117":-7},"anti_affinity_group_view",{"_5374":5380,"_43":5910,"_5376":5913,"_117":-7},"anti_affinity_group_update",{"_5374":5378,"_43":5910,"_5376":5912,"_117":-7},"anti_affinity_group_delete",{"_5374":184,"_43":5910,"_5376":5911,"_117":-7},"anti_affinity_group_member_list",{"_5374":5380,"_43":5908,"_5376":5909,"_117":-7},"anti_affinity_group_member_instance_view",{"_5374":5380,"_43":5904,"_5376":5907,"_117":-7},"anti_affinity_group_member_instance_add",{"_5374":5382,"_43":5904,"_5376":5906,"_117":-7},"anti_affinity_group_member_instance_delete",{"_5374":184,"_43":5904,"_5376":5905,"_117":-7},"current_user_view",{"_5374":5380,"_43":5902,"_5376":5903,"_117":-7},"current_user_groups",{"_5374":5380,"_43":5900,"_5376":5901,"_117":-7},"current_user_ssh_key_list",{"_5374":5380,"_43":5895,"_5376":5898,"_117":5899},"current_user_ssh_key_create",{"_5374":5382,"_43":5895,"_5376":5896,"_117":5897},"current_user_ssh_key_view",{"_5374":5380,"_43":5890,"_5376":5893,"_117":5894},"current_user_ssh_key_delete",{"_5374":184,"_43":5890,"_5376":5891,"_117":5892},"disk_list",{"_5374":5380,"_43":5887,"_5376":5889,"_117":-7},"disk_create",{"_5374":5382,"_43":5887,"_5376":5888,"_117":-7},"disk_view",{"_5374":5380,"_43":5884,"_5376":5886,"_117":-7},"disk_delete",{"_5374":184,"_43":5884,"_5376":5885,"_117":-7},"disk_bulk_write_import",{"_5374":5382,"_43":5882,"_5376":5883,"_117":-7},"disk_bulk_write_import_start",{"_5374":5382,"_43":5879,"_5376":5880,"_117":5881},"disk_bulk_write_import_stop",{"_5374":5382,"_43":5876,"_5376":5877,"_117":5878},"disk_finalize_import",{"_5374":5382,"_43":5874,"_5376":5875,"_117":-7},"probe_list",{"_5374":5380,"_43":5871,"_5376":5873,"_117":-7},"probe_create",{"_5374":5382,"_43":5871,"_5376":5872,"_117":-7},"probe_view",{"_5374":5380,"_43":5868,"_5376":5870,"_117":-7},"probe_delete",{"_5374":184,"_43":5868,"_5376":5869,"_117":-7},"support_bundle_list",{"_5374":5380,"_43":5865,"_5376":5867,"_117":-7},"support_bundle_create",{"_5374":5382,"_43":5865,"_5376":5866,"_117":-7},"support_bundle_view",{"_5374":5380,"_43":5860,"_5376":5864,"_117":-7},"support_bundle_update",{"_5374":5378,"_43":5860,"_5376":5863,"_117":-7},"support_bundle_delete",{"_5374":184,"_43":5860,"_5376":5861,"_117":5862},"support_bundle_download",{"_5374":5380,"_43":5857,"_5376":5859,"_117":-7},"support_bundle_head",{"_5374":5853,"_43":5857,"_5376":5858,"_117":-7},"support_bundle_download_file",{"_5374":5380,"_43":5854,"_5376":5856,"_117":-7},"support_bundle_head_file",{"_5374":5853,"_43":5854,"_5376":5855,"_117":-7},"support_bundle_index",{"_5374":5380,"_43":5851,"_5376":5852,"_117":-7},"affinity_group_list",{"_5374":5380,"_43":5848,"_5376":5850,"_117":-7},"affinity_group_create",{"_5374":5382,"_43":5848,"_5376":5849,"_117":-7},"affinity_group_view",{"_5374":5380,"_43":5844,"_5376":5847,"_117":-7},"affinity_group_update",{"_5374":5378,"_43":5844,"_5376":5846,"_117":-7},"affinity_group_delete",{"_5374":184,"_43":5844,"_5376":5845,"_117":-7},"affinity_group_member_list",{"_5374":5380,"_43":5842,"_5376":5843,"_117":-7},"affinity_group_member_instance_view",{"_5374":5380,"_43":5838,"_5376":5841,"_117":-7},"affinity_group_member_instance_add",{"_5374":5382,"_43":5838,"_5376":5840,"_117":-7},"affinity_group_member_instance_delete",{"_5374":184,"_43":5838,"_5376":5839,"_117":-7},"instance_affinity_group_list",{"_5374":5380,"_43":5836,"_5376":5837,"_117":-7},"instance_multicast_group_list",{"_5374":5380,"_43":5834,"_5376":5835,"_117":-7},"instance_multicast_group_join",{"_5374":5378,"_43":5829,"_5376":5832,"_117":5833},"instance_multicast_group_leave",{"_5374":184,"_43":5829,"_5376":5830,"_117":5831},"multicast_group_list",{"_5374":5380,"_43":5825,"_5376":5828,"_117":-7},"multicast_group_create",{"_5374":5382,"_43":5825,"_5376":5826,"_117":5827},"multicast_group_view",{"_5374":5380,"_43":5821,"_5376":5824,"_117":-7},"multicast_group_update",{"_5374":5378,"_43":5821,"_5376":5823,"_117":-7},"multicast_group_delete",{"_5374":184,"_43":5821,"_5376":5822,"_117":-7},"multicast_group_member_list",{"_5374":5380,"_43":5817,"_5376":5820,"_117":-7},"multicast_group_member_add",{"_5374":5382,"_43":5817,"_5376":5818,"_117":5819},"multicast_group_member_remove",{"_5374":184,"_43":5814,"_5376":5815,"_117":5816},"lookup_multicast_group_by_ip",{"_5374":5380,"_43":5812,"_5376":5813,"_117":-7},"timeseries_query",{"_5374":5382,"_43":5809,"_5376":5810,"_117":5811},"floating_ip_list",{"_5374":5380,"_43":5806,"_5376":5808,"_117":-7},"floating_ip_create",{"_5374":5382,"_43":5806,"_5376":5807,"_117":-7},"floating_ip_view",{"_5374":5380,"_43":5802,"_5376":5805,"_117":-7},"floating_ip_update",{"_5374":5378,"_43":5802,"_5376":5804,"_117":-7},"floating_ip_delete",{"_5374":184,"_43":5802,"_5376":5803,"_117":-7},"floating_ip_attach",{"_5374":5382,"_43":5799,"_5376":5800,"_117":5801},"floating_ip_detach",{"_5374":5382,"_43":5797,"_5376":5798,"_117":-7},"image_list",{"_5374":5380,"_43":5792,"_5376":5795,"_117":5796},"image_create",{"_5374":5382,"_43":5792,"_5376":5793,"_117":5794},"image_view",{"_5374":5380,"_43":5787,"_5376":5790,"_117":5791},"image_delete",{"_5374":184,"_43":5787,"_5376":5788,"_117":5789},"image_demote",{"_5374":5382,"_43":5784,"_5376":5785,"_117":5786},"image_promote",{"_5374":5382,"_43":5781,"_5376":5782,"_117":5783},"instance_list",{"_5374":5380,"_43":5778,"_5376":5780,"_117":-7},"instance_create",{"_5374":5382,"_43":5778,"_5376":5779,"_117":-7},"instance_view",{"_5374":5380,"_43":5774,"_5376":5777,"_117":-7},"instance_update",{"_5374":5378,"_43":5774,"_5376":5776,"_117":-7},"instance_delete",{"_5374":184,"_43":5774,"_5376":5775,"_117":-7},"instance_anti_affinity_group_list",{"_5374":5380,"_43":5772,"_5376":5773,"_117":-7},"instance_disk_list",{"_5374":5380,"_43":5770,"_5376":5771,"_117":-7},"instance_disk_attach",{"_5374":5382,"_43":5768,"_5376":5769,"_117":-7},"instance_disk_detach",{"_5374":5382,"_43":5766,"_5376":5767,"_117":-7},"instance_external_ip_list",{"_5374":5380,"_43":5764,"_5376":5765,"_117":-7},"instance_ephemeral_ip_attach",{"_5374":5382,"_43":5761,"_5376":5763,"_117":-7},"instance_ephemeral_ip_detach",{"_5374":184,"_43":5761,"_5376":5762,"_117":-7},"instance_reboot",{"_5374":5382,"_43":5759,"_5376":5760,"_117":-7},"instance_serial_console",{"_5374":5380,"_43":5757,"_5376":5758,"_117":-7},"instance_serial_console_stream",{"_5374":5380,"_43":5755,"_5376":5756,"_117":-7},"instance_ssh_public_key_list",{"_5374":5380,"_43":5752,"_5376":5753,"_117":5754},"instance_start",{"_5374":5382,"_43":5750,"_5376":5751,"_117":-7},"instance_stop",{"_5374":5382,"_43":5748,"_5376":5749,"_117":-7},"instance_network_interface_list",{"_5374":5380,"_43":5746,"_5376":5387,"_117":-7},"instance_network_interface_create",{"_5374":5382,"_43":5746,"_5376":5747,"_117":-7},"instance_network_interface_view",{"_5374":5380,"_43":5741,"_5376":5745,"_117":-7},"instance_network_interface_update",{"_5374":5378,"_43":5741,"_5376":5744,"_117":-7},"instance_network_interface_delete",{"_5374":184,"_43":5741,"_5376":5742,"_117":5743},"login_saml",{"_5374":5382,"_43":5739,"_5376":5740,"_117":-7},"login_local",{"_5374":5382,"_43":5737,"_5376":5738,"_117":-7},"silo_metric",{"_5374":5380,"_43":5735,"_5376":5578,"_117":5736},"system_policy_view",{"_5374":5380,"_43":5732,"_5376":5734,"_117":-7},"system_policy_update",{"_5374":5378,"_43":5732,"_5376":5733,"_117":-7},"project_ip_pool_list",{"_5374":5380,"_43":5731,"_5376":5615,"_117":-7},"project_ip_pool_view",{"_5374":5380,"_43":5730,"_5376":5611,"_117":-7},"project_list",{"_5374":5380,"_43":5727,"_5376":5729,"_117":-7},"project_create",{"_5374":5382,"_43":5727,"_5376":5728,"_117":-7},"project_view",{"_5374":5380,"_43":5723,"_5376":5726,"_117":-7},"project_update",{"_5374":5378,"_43":5723,"_5376":5725,"_117":-7},"project_delete",{"_5374":184,"_43":5723,"_5376":5724,"_117":-7},"project_policy_view",{"_5374":5380,"_43":5720,"_5376":5722,"_117":-7},"project_policy_update",{"_5374":5378,"_43":5720,"_5376":5721,"_117":-7},"auth_settings_view",{"_5374":5380,"_43":5717,"_5376":5719,"_117":-7},"auth_settings_update",{"_5374":5378,"_43":5717,"_5376":5718,"_117":-7},"certificate_list",{"_5374":5380,"_43":5712,"_5376":5715,"_117":5716},"certificate_create",{"_5374":5382,"_43":5712,"_5376":5713,"_117":5714},"certificate_view",{"_5374":5380,"_43":5707,"_5376":5710,"_117":5711},"certificate_delete",{"_5374":184,"_43":5707,"_5376":5708,"_117":5709},"group_list",{"_5374":5380,"_43":5705,"_5376":5706,"_117":-7},"group_view",{"_5374":5380,"_43":5703,"_5376":5704,"_117":-7},"policy_view",{"_5374":5380,"_43":5700,"_5376":5702,"_117":-7},"policy_update",{"_5374":5378,"_43":5700,"_5376":5701,"_117":-7},"user_list",{"_5374":5380,"_43":5698,"_5376":5699,"_117":-7},"user_view",{"_5374":5380,"_43":5696,"_5376":5697,"_117":-7},"user_token_list",{"_5374":5380,"_43":5694,"_5376":5695,"_117":-7},"user_logout",{"_5374":5382,"_43":5691,"_5376":5692,"_117":5693},"user_session_list",{"_5374":5380,"_43":5689,"_5376":5690,"_117":-7},"utilization_view",{"_5374":5380,"_43":5687,"_5376":5688,"_117":-7},"snapshot_list",{"_5374":5380,"_43":5683,"_5376":5686,"_117":-7},"snapshot_create",{"_5374":5382,"_43":5683,"_5376":5684,"_117":5685},"snapshot_view",{"_5374":5380,"_43":5680,"_5376":5682,"_117":-7},"snapshot_delete",{"_5374":184,"_43":5680,"_5376":5681,"_117":-7},"alert_class_list",{"_5374":5380,"_43":5678,"_5376":5679,"_117":-7},"alert_receiver_list",{"_5374":5380,"_43":5676,"_5376":5677,"_117":-7},"alert_receiver_view",{"_5374":5380,"_43":5673,"_5376":5675,"_117":-7},"alert_receiver_delete",{"_5374":184,"_43":5673,"_5376":5674,"_117":-7},"alert_delivery_list",{"_5374":5380,"_43":5670,"_5376":5671,"_117":5672},"alert_receiver_probe",{"_5374":5382,"_43":5667,"_5376":5668,"_117":5669},"alert_receiver_subscription_add",{"_5374":5382,"_43":5665,"_5376":5666,"_117":-7},"alert_receiver_subscription_remove",{"_5374":184,"_43":5663,"_5376":5664,"_117":-7},"alert_delivery_resend",{"_5374":5382,"_43":5661,"_5376":5662,"_117":-7},"webhook_receiver_create",{"_5374":5382,"_43":5659,"_5376":5660,"_117":-7},"webhook_receiver_update",{"_5374":5378,"_43":5656,"_5376":5657,"_117":5658},"webhook_secrets_list",{"_5374":5380,"_43":5653,"_5376":5655,"_117":-7},"webhook_secrets_add",{"_5374":5382,"_43":5653,"_5376":5654,"_117":-7},"webhook_secrets_delete",{"_5374":184,"_43":5651,"_5376":5652,"_117":-7},"audit_log_list",{"_5374":5380,"_43":5648,"_5376":5649,"_117":5650},"physical_disk_list",{"_5374":5380,"_43":5646,"_5376":5647,"_117":-7},"physical_disk_view",{"_5374":5380,"_43":5644,"_5376":5645,"_117":-7},"rack_list",{"_5374":5380,"_43":5642,"_5376":5643,"_117":-7},"rack_view",{"_5374":5380,"_43":5640,"_5376":5641,"_117":-7},"sled_list",{"_5374":5380,"_43":5637,"_5376":5639,"_117":-7},"sled_add",{"_5374":5382,"_43":5637,"_5376":5638,"_117":-7},"sled_view",{"_5374":5380,"_43":5635,"_5376":5636,"_117":-7},"sled_physical_disk_list",{"_5374":5380,"_43":5633,"_5376":5634,"_117":-7},"sled_instance_list",{"_5374":5380,"_43":5631,"_5376":5632,"_117":-7},"sled_set_provision_policy",{"_5374":5378,"_43":5629,"_5376":5630,"_117":-7},"sled_list_uninitialized",{"_5374":5380,"_43":5627,"_5376":5628,"_117":-7},"networking_switch_port_list",{"_5374":5380,"_43":5625,"_5376":5626,"_117":-7},"networking_switch_port_apply_settings",{"_5374":5382,"_43":5622,"_5376":5624,"_117":-7},"networking_switch_port_clear_settings",{"_5374":184,"_43":5622,"_5376":5623,"_117":-7},"networking_switch_port_status",{"_5374":5380,"_43":5620,"_5376":5621,"_117":-7},"switch_list",{"_5374":5380,"_43":5618,"_5376":5619,"_117":-7},"switch_view",{"_5374":5380,"_43":5616,"_5376":5617,"_117":-7},"ip_pool_list",{"_5374":5380,"_43":5612,"_5376":5615,"_117":-7},"ip_pool_create",{"_5374":5382,"_43":5612,"_5376":5613,"_117":5614},"ip_pool_view",{"_5374":5380,"_43":5608,"_5376":5611,"_117":-7},"ip_pool_update",{"_5374":5378,"_43":5608,"_5376":5610,"_117":-7},"ip_pool_delete",{"_5374":184,"_43":5608,"_5376":5609,"_117":-7},"ip_pool_range_list",{"_5374":5380,"_43":5606,"_5376":5607,"_117":5587},"ip_pool_range_add",{"_5374":5382,"_43":5603,"_5376":5604,"_117":5605},"ip_pool_range_remove",{"_5374":5382,"_43":5601,"_5376":5602,"_117":-7},"ip_pool_silo_list",{"_5374":5380,"_43":5597,"_5376":5600,"_117":-7},"ip_pool_silo_link",{"_5374":5382,"_43":5597,"_5376":5598,"_117":5599},"ip_pool_silo_update",{"_5374":5378,"_43":5592,"_5376":5595,"_117":5596},"ip_pool_silo_unlink",{"_5374":184,"_43":5592,"_5376":5593,"_117":5594},"ip_pool_utilization_view",{"_5374":5380,"_43":5590,"_5376":5591,"_117":-7},"ip_pool_service_view",{"_5374":5380,"_43":5588,"_5376":5589,"_117":-7},"ip_pool_service_range_list",{"_5374":5380,"_43":5585,"_5376":5586,"_117":5587},"ip_pool_service_range_add",{"_5374":5382,"_43":5582,"_5376":5583,"_117":5584},"ip_pool_service_range_remove",{"_5374":5382,"_43":5580,"_5376":5581,"_117":-7},"system_metric",{"_5374":5380,"_43":5577,"_5376":5578,"_117":5579},"system_timeseries_query",{"_5374":5382,"_43":5574,"_5376":5575,"_117":5576},"system_timeseries_schema_list",{"_5374":5380,"_43":5572,"_5376":5573,"_117":-7},"networking_switch_port_lldp_neighbors",{"_5374":5380,"_43":5570,"_5376":5571,"_117":-7},"networking_switch_port_lldp_config_view",{"_5374":5380,"_43":5567,"_5376":5569,"_117":-7},"networking_switch_port_lldp_config_update",{"_5374":5382,"_43":5567,"_5376":5568,"_117":-7},"networking_address_lot_list",{"_5374":5380,"_43":5564,"_5376":5566,"_117":-7},"networking_address_lot_create",{"_5374":5382,"_43":5564,"_5376":5565,"_117":-7},"networking_address_lot_view",{"_5374":5380,"_43":5561,"_5376":5563,"_117":-7},"networking_address_lot_delete",{"_5374":184,"_43":5561,"_5376":5562,"_117":-7},"networking_address_lot_block_list",{"_5374":5380,"_43":5559,"_5376":5560,"_117":-7},"networking_allow_list_view",{"_5374":5380,"_43":5556,"_5376":5558,"_117":-7},"networking_allow_list_update",{"_5374":5378,"_43":5556,"_5376":5557,"_117":-7},"networking_bfd_disable",{"_5374":5382,"_43":5554,"_5376":5555,"_117":-7},"networking_bfd_enable",{"_5374":5382,"_43":5552,"_5376":5553,"_117":-7},"networking_bfd_status",{"_5374":5380,"_43":5550,"_5376":5551,"_117":-7},"networking_bgp_config_list",{"_5374":5380,"_43":5546,"_5376":5549,"_117":-7},"networking_bgp_config_create",{"_5374":5382,"_43":5546,"_5376":5548,"_117":-7},"networking_bgp_config_delete",{"_5374":184,"_43":5546,"_5376":5547,"_117":-7},"networking_bgp_announce_set_list",{"_5374":5380,"_43":5542,"_5376":5545,"_117":-7},"networking_bgp_announce_set_update",{"_5374":5378,"_43":5542,"_5376":5543,"_117":5544},"networking_bgp_announce_set_delete",{"_5374":184,"_43":5540,"_5376":5541,"_117":-7},"networking_bgp_announcement_list",{"_5374":5380,"_43":5538,"_5376":5539,"_117":-7},"networking_bgp_exported",{"_5374":5380,"_43":5536,"_5376":5537,"_117":-7},"networking_bgp_message_history",{"_5374":5380,"_43":5534,"_5376":5535,"_117":-7},"networking_bgp_imported_routes_ipv4",{"_5374":5380,"_43":5532,"_5376":5533,"_117":-7},"networking_bgp_status",{"_5374":5380,"_43":5530,"_5376":5531,"_117":-7},"networking_inbound_icmp_view",{"_5374":5380,"_43":5527,"_5376":5529,"_117":-7},"networking_inbound_icmp_update",{"_5374":5378,"_43":5527,"_5376":5528,"_117":-7},"networking_loopback_address_list",{"_5374":5380,"_43":5524,"_5376":5526,"_117":-7},"networking_loopback_address_create",{"_5374":5382,"_43":5524,"_5376":5525,"_117":-7},"networking_loopback_address_delete",{"_5374":184,"_43":5522,"_5376":5523,"_117":-7},"networking_switch_port_settings_list",{"_5374":5380,"_43":5518,"_5376":5521,"_117":-7},"networking_switch_port_settings_create",{"_5374":5382,"_43":5518,"_5376":5520,"_117":-7},"networking_switch_port_settings_delete",{"_5374":184,"_43":5518,"_5376":5519,"_117":-7},"networking_switch_port_settings_view",{"_5374":5380,"_43":5516,"_5376":5517,"_117":-7},"silo_identity_provider_list",{"_5374":5380,"_43":5513,"_5376":5514,"_117":5515},"local_idp_user_create",{"_5374":5382,"_43":5510,"_5376":5511,"_117":5512},"local_idp_user_delete",{"_5374":184,"_43":5508,"_5376":5509,"_117":-7},"local_idp_user_set_password",{"_5374":5382,"_43":5505,"_5376":5506,"_117":5507},"saml_identity_provider_create",{"_5374":5382,"_43":5503,"_5376":5504,"_117":-7},"saml_identity_provider_view",{"_5374":5380,"_43":5501,"_5376":5502,"_117":-7},"scim_token_list",{"_5374":5380,"_43":5497,"_5376":5500,"_117":5495},"scim_token_create",{"_5374":5382,"_43":5497,"_5376":5498,"_117":5499},"scim_token_view",{"_5374":5380,"_43":5493,"_5376":5496,"_117":5495},"scim_token_delete",{"_5374":184,"_43":5493,"_5376":5494,"_117":5495},"system_quotas_list",{"_5374":5380,"_43":5491,"_5376":5492,"_117":-7},"silo_list",{"_5374":5380,"_43":5487,"_5376":5489,"_117":5490},"silo_create",{"_5374":5382,"_43":5487,"_5376":5488,"_117":-7},"silo_view",{"_5374":5380,"_43":5482,"_5376":5485,"_117":5486},"silo_delete",{"_5374":184,"_43":5482,"_5376":5483,"_117":5484},"silo_ip_pool_list",{"_5374":5380,"_43":5479,"_5376":5480,"_117":5481},"silo_policy_view",{"_5374":5380,"_43":5476,"_5376":5478,"_117":-7},"silo_policy_update",{"_5374":5378,"_43":5476,"_5376":5477,"_117":-7},"silo_quotas_view",{"_5374":5380,"_43":5472,"_5376":5475,"_117":-7},"silo_quotas_update",{"_5374":5378,"_43":5472,"_5376":5473,"_117":5474},"silo_user_list",{"_5374":5380,"_43":5470,"_5376":5471,"_117":-7},"silo_user_view",{"_5374":5380,"_43":5468,"_5376":5469,"_117":-7},"user_builtin_list",{"_5374":5380,"_43":5466,"_5376":5467,"_117":-7},"user_builtin_view",{"_5374":5380,"_43":5464,"_5376":5465,"_117":-7},"silo_utilization_list",{"_5374":5380,"_43":5462,"_5376":5463,"_117":-7},"silo_utilization_view",{"_5374":5380,"_43":5460,"_5376":5461,"_117":-7},{"_5374":5380,"_43":5457,"_5376":5458,"_117":5459},"system_update_repository_list",{"_5374":5380,"_43":5452,"_5376":5455,"_117":5456},"system_update_repository_upload",{"_5374":5378,"_43":5452,"_5376":5453,"_117":5454},"system_update_repository_view",{"_5374":5380,"_43":5450,"_5376":5451,"_117":-7},"system_update_status",{"_5374":5380,"_43":5447,"_5376":5448,"_117":5449},"target_release_update",{"_5374":5378,"_43":5444,"_5376":5445,"_117":5446},"system_update_trust_root_list",{"_5374":5380,"_43":5440,"_5376":5442,"_117":5443},"system_update_trust_root_create",{"_5374":5382,"_43":5440,"_5376":5441,"_117":-7},"system_update_trust_root_view",{"_5374":5380,"_43":5436,"_5376":5439,"_117":-7},"system_update_trust_root_delete",{"_5374":184,"_43":5436,"_5376":5437,"_117":5438},"current_user_access_token_list",{"_5374":5380,"_43":5433,"_5376":5434,"_117":5435},"current_user_access_token_delete",{"_5374":184,"_43":5430,"_5376":5431,"_117":5432},"internet_gateway_ip_address_list",{"_5374":5380,"_43":5427,"_5376":5429,"_117":-7},"internet_gateway_ip_address_create",{"_5374":5382,"_43":5427,"_5376":5428,"_117":-7},"internet_gateway_ip_address_delete",{"_5374":184,"_43":5425,"_5376":5426,"_117":-7},"internet_gateway_ip_pool_list",{"_5374":5380,"_43":5422,"_5376":5424,"_117":-7},"internet_gateway_ip_pool_create",{"_5374":5382,"_43":5422,"_5376":5423,"_117":-7},"internet_gateway_ip_pool_delete",{"_5374":184,"_43":5420,"_5376":5421,"_117":-7},"internet_gateway_list",{"_5374":5380,"_43":5417,"_5376":5419,"_117":-7},"internet_gateway_create",{"_5374":5382,"_43":5417,"_5376":5418,"_117":-7},"internet_gateway_view",{"_5374":5380,"_43":5414,"_5376":5416,"_117":-7},"internet_gateway_delete",{"_5374":184,"_43":5414,"_5376":5415,"_117":-7},"vpc_firewall_rules_view",{"_5374":5380,"_43":5410,"_5376":5413,"_117":-7},"vpc_firewall_rules_update",{"_5374":5378,"_43":5410,"_5376":5411,"_117":5412},"vpc_router_route_list",{"_5374":5380,"_43":5406,"_5376":5408,"_117":5409},"vpc_router_route_create",{"_5374":5382,"_43":5406,"_5376":5407,"_117":-7},"vpc_router_route_view",{"_5374":5380,"_43":5402,"_5376":5405,"_117":-7},"vpc_router_route_update",{"_5374":5378,"_43":5402,"_5376":5404,"_117":-7},"vpc_router_route_delete",{"_5374":184,"_43":5402,"_5376":5403,"_117":-7},"vpc_router_list",{"_5374":5380,"_43":5399,"_5376":5401,"_117":-7},"vpc_router_create",{"_5374":5382,"_43":5399,"_5376":5400,"_117":-7},"vpc_router_view",{"_5374":5380,"_43":5395,"_5376":5398,"_117":-7},"vpc_router_update",{"_5374":5378,"_43":5395,"_5376":5397,"_117":-7},"vpc_router_delete",{"_5374":184,"_43":5395,"_5376":5396,"_117":-7},"vpc_subnet_list",{"_5374":5380,"_43":5392,"_5376":5394,"_117":-7},"vpc_subnet_create",{"_5374":5382,"_43":5392,"_5376":5393,"_117":-7},"vpc_subnet_view",{"_5374":5380,"_43":5388,"_5376":5391,"_117":-7},"vpc_subnet_update",{"_5374":5378,"_43":5388,"_5376":5390,"_117":-7},"vpc_subnet_delete",{"_5374":184,"_43":5388,"_5376":5389,"_117":-7},"vpc_subnet_list_network_interfaces",{"_5374":5380,"_43":5386,"_5376":5387,"_117":-7},"vpc_list",{"_5374":5380,"_43":5383,"_5376":5385,"_117":-7},"vpc_create",{"_5374":5382,"_43":5383,"_5376":5384,"_117":-7},"vpc_view",{"_5374":5380,"_43":5375,"_5376":5381,"_117":-7},"vpc_update",{"_5374":5378,"_43":5375,"_5376":5379,"_117":-7},"vpc_delete",{"_5374":184,"_43":5375,"_5376":5377,"_117":-7},"type","/v1/vpcs/{vpc}","summary","Delete VPC","put","Update a VPC","get","Fetch VPC","post","/v1/vpcs","Create VPC","List VPCs","/v1/vpc-subnets/{subnet}/network-interfaces","List network interfaces","/v1/vpc-subnets/{subnet}","Delete subnet","Update subnet","Fetch subnet","/v1/vpc-subnets","Create subnet","List subnets","/v1/vpc-routers/{router}","Delete router","Update router","Fetch router","/v1/vpc-routers","Create VPC router","List routers","/v1/vpc-router-routes/{route}","Delete route","Update route","Fetch route","/v1/vpc-router-routes","Create route","List routes","

List the routes associated with a router in a particular VPC.

\n","/v1/vpc-firewall-rules","Replace firewall rules","

The maximum number of rules per VPC is 1024.

\n","List firewall rules","/v1/internet-gateways/{gateway}","Delete internet gateway","Fetch internet gateway","/v1/internet-gateways","Create VPC internet gateway","List internet gateways","/v1/internet-gateway-ip-pools/{pool}","Detach IP pool from internet gateway","/v1/internet-gateway-ip-pools","Attach IP pool to internet gateway","List IP pools attached to internet gateway","/v1/internet-gateway-ip-addresses/{address}","Detach IP address from internet gateway","/v1/internet-gateway-ip-addresses","Attach IP address to internet gateway","List IP addresses attached to internet gateway","/v1/me/access-tokens/{token_id}","Delete access token","

Delete a device access token for the currently authenticated user.

\n","/v1/me/access-tokens","List access tokens","

List device access tokens for the currently authenticated user.

\n","/v1/system/update/trust-roots/{trust_root_id}","Delete trusted root role","

Note that this method does not currently check for any uploaded system release repositories that would become untrusted after deleting the root role.

\n","Fetch trusted root role","/v1/system/update/trust-roots","Add trusted root role to updates trust store","List root roles in the updates trust store","

\n","/v1/system/update/target-release","Set target release","

\n","/v1/system/update/status","Fetch system update status","

Returns information about the current target release and the progress of system software updates.

\n","/v1/system/update/repositories/{system_version}","Fetch system release repository by version","/v1/system/update/repositories","Upload system release repository","

System release repositories are verified by the updates trust store.

\n","List all TUF repositories","

Returns a paginated list of all TUF repositories ordered by system version (newest first by default).

\n","/v1/ping","Ping API","

Always responds with Ok if it responds at all.

\n","/v1/system/utilization/silos/{silo}","Fetch current utilization for given silo","/v1/system/utilization/silos","List current utilization state for all silos","/v1/system/users-builtin/{user}","Fetch built-in user","/v1/system/users-builtin","List built-in users","/v1/system/users/{user_id}","Fetch built-in (system) user","/v1/system/users","List built-in (system) users in silo","/v1/system/silos/{silo}/quotas","Update resource quotas for silo","

If a quota value is not specified, it will remain unchanged.

\n","Fetch resource quotas for silo","/v1/system/silos/{silo}/policy","Update silo IAM policy","Fetch silo IAM policy","/v1/system/silos/{silo}/ip-pools","List IP pools linked to silo","

Linked IP pools are available to users in the specified silo. A silo can have at most one default pool. IPs are allocated from the default pool when users ask for one without specifying a pool.

\n","/v1/system/silos/{silo}","Delete a silo","

Delete a silo by name or ID.

\n","Fetch silo","

Fetch silo by name or ID.

\n","/v1/system/silos","Create a silo","List silos","

Lists silos that are discoverable based on the current permissions.

\n","/v1/system/silo-quotas","Lists resource quotas for all silos","/v1/system/scim/tokens/{token_id}","Delete SCIM token","

Specify the silo by name or ID using the silo query parameter.

\n","Fetch SCIM token","/v1/system/scim/tokens","Create SCIM token","

Specify the silo by name or ID using the silo query parameter. Be sure to save the bearer token in the response. It will not be retrievable later through the token view and list endpoints.

\n","List SCIM tokens","/v1/system/identity-providers/saml/{provider}","Fetch SAML identity provider","/v1/system/identity-providers/saml","Create SAML identity provider","/v1/system/identity-providers/local/users/{user_id}/set-password","Set or invalidate user's password","

Passwords can only be updated for users in Silos with identity mode LocalOnly.

\n","/v1/system/identity-providers/local/users/{user_id}","Delete user","/v1/system/identity-providers/local/users","Create user","

Users can only be created in Silos with provision_type == Fixed. Otherwise, Silo users are just-in-time (JIT) provisioned when a user first logs in using an external Identity Provider.

\n","/v1/system/identity-providers","List identity providers for silo","

List identity providers for silo by silo name or ID.

\n","/v1/system/networking/switch-port-settings/{port}","Get information about switch port","/v1/system/networking/switch-port-settings","Delete switch port settings","Create switch port settings","List switch port settings","/v1/system/networking/loopback-address/{rack_id}/{switch_location}/{address}/{subnet_mask}","Delete loopback address","/v1/system/networking/loopback-address","Create loopback address","List loopback addresses","/v1/system/networking/inbound-icmp","Set whether API services can receive limited ICMP traffic","Return whether API services can receive limited ICMP traffic","/v1/system/networking/bgp-status","Get BGP peer status","/v1/system/networking/bgp-routes-ipv4","Get imported IPv4 BGP routes","/v1/system/networking/bgp-message-history","Get BGP router message history","/v1/system/networking/bgp-exported","Get BGP exported routes","/v1/system/networking/bgp-announce-set/{announce_set}/announcement","Get originated routes for a specified BGP announce set","/v1/system/networking/bgp-announce-set/{announce_set}","Delete BGP announce set","/v1/system/networking/bgp-announce-set","Update BGP announce set","

If the announce set exists, this endpoint replaces the existing announce set with the one specified.

\n","List BGP announce sets","/v1/system/networking/bgp","Delete BGP configuration","Create new BGP configuration","List BGP configurations","/v1/system/networking/bfd-status","Get BFD status","/v1/system/networking/bfd-enable","Enable a BFD session","/v1/system/networking/bfd-disable","Disable a BFD session","/v1/system/networking/allow-list","Update user-facing services IP allowlist","Get user-facing services IP allowlist","/v1/system/networking/address-lot/{address_lot}/blocks","List blocks in address lot","/v1/system/networking/address-lot/{address_lot}","Delete address lot","Fetch address lot","/v1/system/networking/address-lot","Create address lot","List address lots","/v1/system/hardware/switch-port/{port}/lldp/config","Update the LLDP configuration for a switch port","Fetch the LLDP configuration for a switch port","/v1/system/hardware/rack-switch-port/{rack_id}/{switch_location}/{port}/lldp/neighbors","Fetch the LLDP neighbors seen on a switch port","/v1/system/timeseries/schemas","List timeseries schemas","/v1/system/timeseries/query","Run timeseries query","

Queries are written in OxQL.

\n","/v1/system/metrics/{metric_name}","View metrics","

View CPU, memory, or storage utilization metrics at the fleet or silo level.

\n","/v1/system/ip-pools-service/ranges/remove","Remove IP range from Oxide service pool","/v1/system/ip-pools-service/ranges/add","Add IP range to Oxide service pool","

IPv6 ranges are not allowed yet.

\n","/v1/system/ip-pools-service/ranges","List IP ranges for the Oxide service pool","

Ranges are ordered by their first address.

\n","/v1/system/ip-pools-service","Fetch Oxide service IP pool","/v1/system/ip-pools/{pool}/utilization","Fetch IP pool utilization","/v1/system/ip-pools/{pool}/silos/{silo}","Unlink IP pool from silo","

Will fail if there are any outstanding IPs allocated in the silo.

\n","Make IP pool default for silo","

\n","/v1/system/ip-pools/{pool}/silos","Link IP pool to silo","

\n","List IP pool's linked silos","/v1/system/ip-pools/{pool}/ranges/remove","Remove range from IP pool","/v1/system/ip-pools/{pool}/ranges/add","Add range to IP pool.","

IPv6 ranges are not allowed yet for unicast pools.

For multicast pools, all ranges must be either Any-Source Multicast (ASM) or Source-Specific Multicast (SSM), but not both. Mixing ASM and SSM ranges in the same pool is not allowed.

ASM: IPv4 addresses outside 232.0.0.0/8, IPv6 addresses with flag field != 3 SSM: IPv4 addresses in 232.0.0.0/8, IPv6 addresses with flag field = 3

\n","/v1/system/ip-pools/{pool}/ranges","List ranges for IP pool","/v1/system/ip-pools/{pool}","Delete IP pool","Update IP pool","Fetch IP pool","/v1/system/ip-pools","Create IP pool","

IPv6 is not yet supported for unicast pools.

\n","List IP pools","/v1/system/hardware/switches/{switch_id}","Fetch switch","/v1/system/hardware/switches","List switches","/v1/system/hardware/switch-port/{port}/status","Get switch port status","/v1/system/hardware/switch-port/{port}/settings","Clear switch port settings","Apply switch port settings","/v1/system/hardware/switch-port","List switch ports","/v1/system/hardware/sleds-uninitialized","List uninitialized sleds","/v1/system/hardware/sleds/{sled_id}/provision-policy","Set sled provision policy","/v1/system/hardware/sleds/{sled_id}/instances","List instances running on given sled","/v1/system/hardware/sleds/{sled_id}/disks","List physical disks attached to sleds","/v1/system/hardware/sleds/{sled_id}","Fetch sled","/v1/system/hardware/sleds","Add sled to initialized rack","List sleds","/v1/system/hardware/racks/{rack_id}","Fetch rack","/v1/system/hardware/racks","List racks","/v1/system/hardware/disks/{disk_id}","Get a physical disk","/v1/system/hardware/disks","List physical disks","/v1/system/audit-log","View audit log","

\n","/v1/webhook-secrets/{secret_id}","Remove secret from webhook receiver","/v1/webhook-secrets","Add secret to webhook receiver","List webhook receiver secret IDs","/v1/webhook-receivers/{receiver}","Update webhook receiver","

Note that receiver secrets are NOT added or removed using this endpoint. Instead, use the /v1/webhooks/{secrets}/?receiver={receiver} endpoint to add and remove secrets.

\n","/v1/webhook-receivers","Create webhook receiver","/v1/alerts/{alert_id}/resend","Request re-delivery of alert","/v1/alert-receivers/{receiver}/subscriptions/{subscription}","Remove alert receiver subscription","/v1/alert-receivers/{receiver}/subscriptions","Add alert receiver subscription","/v1/alert-receivers/{receiver}/probe","Send liveness probe to alert receiver","

\n","/v1/alert-receivers/{receiver}/deliveries","List delivery attempts to alert receiver","

\n","/v1/alert-receivers/{receiver}","Delete alert receiver","Fetch alert receiver","/v1/alert-receivers","List alert receivers","/v1/alert-classes","List alert classes","/v1/snapshots/{snapshot}","Delete snapshot","Fetch snapshot","/v1/snapshots","Create snapshot","

Creates a point-in-time snapshot from a disk.

\n","List snapshots","/v1/utilization","Fetch resource utilization for user's current silo","/v1/users/{user_id}/sessions","List user's console sessions","/v1/users/{user_id}/logout","Log user out","

Silo admins can use this endpoint to log the specified user out by deleting all of their tokens AND sessions. This cannot be undone.

\n","/v1/users/{user_id}/access-tokens","List user's access tokens","/v1/users/{user_id}","Fetch user","/v1/users","List users","/v1/policy","Update current silo's IAM policy","Fetch current silo's IAM policy","/v1/groups/{group_id}","Fetch group","/v1/groups","List groups","/v1/certificates/{certificate}","Delete certificate","

Permanently delete a certificate. This operation cannot be undone.

\n","Fetch certificate","

Returns the details of a specific certificate

\n","/v1/certificates","Create new system-wide x.509 certificate","

This certificate is automatically used by the Oxide Control plane to serve external connections.

\n","List certificates for external endpoints","

Returns a list of TLS certificates used for the external API (for the current Silo). These are sorted by creation date, with the most recent certificates appearing first.

\n","/v1/auth-settings","Update current silo's auth settings","Fetch current silo's auth settings","/v1/projects/{project}/policy","Update project's IAM policy","Fetch project's IAM policy","/v1/projects/{project}","Delete project","Update a project","Fetch project","/v1/projects","Create project","List projects","/v1/ip-pools/{pool}","/v1/ip-pools","/v1/system/policy","Update top-level IAM policy","Fetch top-level IAM policy","/v1/metrics/{metric_name}","

View CPU, memory, or storage utilization metrics at the silo or project level.

\n","/v1/login/{silo_name}/local","Authenticate a user via username and password","/login/{silo_name}/saml/{provider_name}","Authenticate a user via SAML","/v1/network-interfaces/{interface}","Delete network interface","

\n","Update network interface","Fetch network interface","/v1/network-interfaces","Create network interface","/v1/instances/{instance}/stop","Stop instance","/v1/instances/{instance}/start","Boot instance","/v1/instances/{instance}/ssh-public-keys","List SSH public keys for instance","

List SSH public keys injected via cloud-init during instance creation. Note that this list is a snapshot in time and will not reflect updates made after the instance is created.

\n","/v1/instances/{instance}/serial-console/stream","Stream instance serial console","/v1/instances/{instance}/serial-console","Fetch instance serial console","/v1/instances/{instance}/reboot","Reboot an instance","/v1/instances/{instance}/external-ips/ephemeral","Detach and deallocate ephemeral IP from instance","Allocate and attach ephemeral IP to instance","/v1/instances/{instance}/external-ips","List external IP addresses","/v1/instances/{instance}/disks/detach","Detach disk from instance","/v1/instances/{instance}/disks/attach","Attach disk to instance","/v1/instances/{instance}/disks","List disks for instance","/v1/instances/{instance}/anti-affinity-groups","List anti-affinity groups containing instance","/v1/instances/{instance}","Delete instance","Update instance","Fetch instance","/v1/instances","Create instance","List instances","/v1/images/{image}/promote","Promote project image","

Promote project image to be visible to all projects in the silo

\n","/v1/images/{image}/demote","Demote silo image","

Demote silo image to be visible only to a specified project

\n","/v1/images/{image}","Delete image","

\n","Fetch image","

Fetch the details for a specific image in a project.

\n","/v1/images","Create image","

Create a new image in a project.

\n","List images","

List images which are global or scoped to the specified project. The images are returned sorted by creation date, with the most recent images appearing first.

\n","/v1/floating-ips/{floating_ip}/detach","Detach floating IP","/v1/floating-ips/{floating_ip}/attach","Attach floating IP","

Attach floating IP to an instance or other resource.

\n","/v1/floating-ips/{floating_ip}","Delete floating IP","Update floating IP","Fetch floating IP","/v1/floating-ips","Create floating IP","List floating IPs","/v1/timeseries/query","Run project-scoped timeseries query","

Queries are written in OxQL. Project must be specified by name or ID in URL query parameter. The OxQL query will only return timeseries data from the specified project.

\n","/v1/system/multicast-groups/by-ip/{address}","Look up multicast group by IP address.","/v1/multicast-groups/{multicast_group}/members/{instance}","Remove instance from a multicast group.","

Functionally equivalent to removing the group from the instance's multicast_groups field. Both approaches modify the same underlying membership and trigger reconciliation.

Specify instance by name (requires ?project=<name>) or UUID.

\n","/v1/multicast-groups/{multicast_group}/members","Add instance to a multicast group.","

Functionally equivalent to updating the instance's multicast_groups field. Both approaches modify the same underlying membership and trigger the same reconciliation logic.

Specify instance by name (requires ?project=<name>) or UUID.

\n","List members of a multicast group.","/v1/multicast-groups/{multicast_group}","Delete a multicast group.","Update a multicast group.","Fetch a multicast group.","/v1/multicast-groups","Create a multicast group.","

Multicast groups are fleet-scoped resources that can be joined by instances across projects and silos. A single multicast IP serves all group members regardless of project or silo boundaries.

\n","List all multicast groups.","/v1/instances/{instance}/multicast-groups/{multicast_group}","Leave multicast group.","

This is functionally equivalent to removing the instance via the group's member management endpoint or updating the instance's multicast_groups field. All approaches modify the same membership and trigger reconciliation.

\n","Join multicast group.","

This is functionally equivalent to adding the instance via the group's member management endpoint or updating the instance's multicast_groups field. All approaches modify the same membership and trigger reconciliation.

\n","/v1/instances/{instance}/multicast-groups","List multicast groups for instance","/v1/instances/{instance}/affinity-groups","List affinity groups containing instance","/v1/affinity-groups/{affinity_group}/members/instance/{instance}","Remove member from affinity group","Add member to affinity group","Fetch affinity group member","/v1/affinity-groups/{affinity_group}/members","List affinity group members","/v1/affinity-groups/{affinity_group}","Delete affinity group","Update affinity group","Fetch affinity group","/v1/affinity-groups","Create affinity group","List affinity groups","/experimental/v1/system/support-bundles/{bundle_id}/index","Download the index of a support bundle","head","/experimental/v1/system/support-bundles/{bundle_id}/download/{file}","Download the metadata of a file within the support bundle","Download a file within a support bundle","/experimental/v1/system/support-bundles/{bundle_id}/download","Download the metadata of a support bundle","Download the contents of a support bundle","/experimental/v1/system/support-bundles/{bundle_id}","Delete an existing support bundle","

May also be used to cancel a support bundle which is currently being collected, or to remove metadata for a support bundle that has failed.

\n","Update a support bundle","View a support bundle","/experimental/v1/system/support-bundles","Create a new support bundle","List all support bundles","/experimental/v1/probes/{probe}","Delete instrumentation probe","View instrumentation probe","/experimental/v1/probes","Create instrumentation probe","List instrumentation probes","/v1/disks/{disk}/finalize","Confirm disk block import completion","/v1/disks/{disk}/bulk-write-stop","Stop importing blocks into disk","

Stop the process of importing blocks into a disk

\n","/v1/disks/{disk}/bulk-write-start","Start importing blocks into disk","

Start the process of importing blocks into a disk

\n","/v1/disks/{disk}/bulk-write","Import blocks into disk","/v1/disks/{disk}","Delete disk","Fetch disk","/v1/disks","Create a disk","List disks","/v1/me/ssh-keys/{ssh_key}","Delete SSH public key","

Delete an SSH public key associated with the currently authenticated user.

\n","Fetch SSH public key","

Fetch SSH public key associated with the currently authenticated user.

\n","/v1/me/ssh-keys","Create SSH public key","

Create an SSH public key for the currently authenticated user.

\n","List SSH public keys","

Lists SSH public keys for the currently authenticated user.

\n","/v1/me/groups","Fetch current user's groups","/v1/me","Fetch user for current session","/v1/anti-affinity-groups/{anti_affinity_group}/members/instance/{instance}","Remove member from anti-affinity group","Add member to anti-affinity group","Fetch anti-affinity group member","/v1/anti-affinity-groups/{anti_affinity_group}/members","List anti-affinity group members","/v1/anti-affinity-groups/{anti_affinity_group}","Delete anti-affinity group","Update anti-affinity group","Fetch anti-affinity group","/v1/anti-affinity-groups","Create anti-affinity group","List anti-affinity groups"]

$oxideping

Options

$
oxide
ping