Lists SSH public keys for the currently authenticated user.

\n","current_user_ssh_key_create",{"_15":24,"_17":62,"_19":67,"_21":68},"Create SSH public key","

Create an SSH public key for the currently authenticated user.

\n","current_user_ssh_key_view",{"_15":16,"_17":71,"_19":72,"_21":73},"/v1/me/ssh-keys/{ssh_key}","Fetch SSH public key","

Fetch SSH public key associated with the currently authenticated user.

\n","current_user_ssh_key_delete",{"_15":36,"_17":71,"_19":76,"_21":77},"Delete SSH public key","

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

\n","disk_list",{"_15":16,"_17":80,"_19":81,"_21":-7},"/v1/disks","List disks","disk_create",{"_15":24,"_17":80,"_19":84,"_21":-7},"Create a disk","disk_view",{"_15":16,"_17":87,"_19":88,"_21":-7},"/v1/disks/{disk}","Fetch disk","disk_delete",{"_15":36,"_17":87,"_19":91,"_21":-7},"Delete disk","disk_bulk_write_import",{"_15":24,"_17":94,"_19":95,"_21":-7},"/v1/disks/{disk}/bulk-write","Import blocks into disk","disk_bulk_write_import_start",{"_15":24,"_17":98,"_19":99,"_21":100},"/v1/disks/{disk}/bulk-write-start","Start importing blocks into disk","

Start the process of importing blocks into a disk

\n","disk_bulk_write_import_stop",{"_15":24,"_17":103,"_19":104,"_21":105},"/v1/disks/{disk}/bulk-write-stop","Stop importing blocks into disk","

Stop the process of importing blocks into a disk

\n","disk_finalize_import",{"_15":24,"_17":108,"_19":109,"_21":-7},"/v1/disks/{disk}/finalize","Confirm disk block import completion","probe_list",{"_15":16,"_17":112,"_19":113,"_21":-7},"/experimental/v1/probes","List instrumentation probes","probe_create",{"_15":24,"_17":112,"_19":116,"_21":-7},"Create instrumentation probe","probe_view",{"_15":16,"_17":119,"_19":120,"_21":-7},"/experimental/v1/probes/{probe}","View instrumentation probe","probe_delete",{"_15":36,"_17":119,"_19":123,"_21":-7},"Delete instrumentation probe","support_bundle_list",{"_15":16,"_17":126,"_19":127,"_21":-7},"/experimental/v1/system/support-bundles","List all support bundles","support_bundle_create",{"_15":24,"_17":126,"_19":130,"_21":-7},"Create a new support bundle","support_bundle_view",{"_15":16,"_17":133,"_19":134,"_21":-7},"/experimental/v1/system/support-bundles/{bundle_id}","View a support bundle","support_bundle_update",{"_15":32,"_17":133,"_19":137,"_21":-7},"Update a support bundle","support_bundle_delete",{"_15":36,"_17":133,"_19":140,"_21":141},"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","support_bundle_download",{"_15":16,"_17":144,"_19":145,"_21":-7},"/experimental/v1/system/support-bundles/{bundle_id}/download","Download the contents of a support bundle","support_bundle_head",{"_15":148,"_17":144,"_19":149,"_21":-7},"head","Download the metadata of a support bundle","support_bundle_download_file",{"_15":16,"_17":152,"_19":153,"_21":-7},"/experimental/v1/system/support-bundles/{bundle_id}/download/{file}","Download a file within a support bundle","support_bundle_head_file",{"_15":148,"_17":152,"_19":156,"_21":-7},"Download the metadata of a file within the support bundle","support_bundle_index",{"_15":16,"_17":159,"_19":160,"_21":-7},"/experimental/v1/system/support-bundles/{bundle_id}/index","Download the index of a support bundle","affinity_group_list",{"_15":16,"_17":163,"_19":164,"_21":-7},"/v1/affinity-groups","List affinity groups","affinity_group_create",{"_15":24,"_17":163,"_19":167,"_21":-7},"Create affinity group","affinity_group_view",{"_15":16,"_17":170,"_19":171,"_21":-7},"/v1/affinity-groups/{affinity_group}","Fetch affinity group","affinity_group_update",{"_15":32,"_17":170,"_19":174,"_21":-7},"Update affinity group","affinity_group_delete",{"_15":36,"_17":170,"_19":177,"_21":-7},"Delete affinity group","affinity_group_member_list",{"_15":16,"_17":180,"_19":181,"_21":-7},"/v1/affinity-groups/{affinity_group}/members","List affinity group members","affinity_group_member_instance_view",{"_15":16,"_17":184,"_19":185,"_21":-7},"/v1/affinity-groups/{affinity_group}/members/instance/{instance}","Fetch affinity group member","affinity_group_member_instance_add",{"_15":24,"_17":184,"_19":188,"_21":-7},"Add member to affinity group","affinity_group_member_instance_delete",{"_15":36,"_17":184,"_19":191,"_21":-7},"Remove member from affinity group","instance_affinity_group_list",{"_15":16,"_17":194,"_19":195,"_21":-7},"/v1/instances/{instance}/affinity-groups","List affinity groups containing instance","timeseries_query",{"_15":24,"_17":198,"_19":199,"_21":200},"/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","floating_ip_list",{"_15":16,"_17":203,"_19":204,"_21":-7},"/v1/floating-ips","List floating IPs","floating_ip_create",{"_15":24,"_17":203,"_19":207,"_21":-7},"Create floating IP","floating_ip_view",{"_15":16,"_17":210,"_19":211,"_21":-7},"/v1/floating-ips/{floating_ip}","Fetch floating IP","floating_ip_update",{"_15":32,"_17":210,"_19":214,"_21":-7},"Update floating IP","floating_ip_delete",{"_15":36,"_17":210,"_19":217,"_21":-7},"Delete floating IP","floating_ip_attach",{"_15":24,"_17":220,"_19":221,"_21":222},"/v1/floating-ips/{floating_ip}/attach","Attach floating IP","

Attach floating IP to an instance or other resource.

\n","floating_ip_detach",{"_15":24,"_17":225,"_19":226,"_21":-7},"/v1/floating-ips/{floating_ip}/detach","Detach floating IP","image_list",{"_15":16,"_17":229,"_19":230,"_21":231},"/v1/images","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","image_create",{"_15":24,"_17":229,"_19":234,"_21":235},"Create image","

Create a new image in a project.

\n","image_view",{"_15":16,"_17":238,"_19":239,"_21":240},"/v1/images/{image}","Fetch image","

Fetch the details for a specific image in a project.

\n","image_delete",{"_15":36,"_17":238,"_19":243,"_21":244},"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","image_demote",{"_15":24,"_17":247,"_19":248,"_21":249},"/v1/images/{image}/demote","Demote silo image","

Demote silo image to be visible only to a specified project

\n","image_promote",{"_15":24,"_17":252,"_19":253,"_21":254},"/v1/images/{image}/promote","Promote project image","

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

\n","instance_list",{"_15":16,"_17":257,"_19":258,"_21":-7},"/v1/instances","List instances","instance_create",{"_15":24,"_17":257,"_19":261,"_21":-7},"Create instance","instance_view",{"_15":16,"_17":264,"_19":265,"_21":-7},"/v1/instances/{instance}","Fetch instance","instance_update",{"_15":32,"_17":264,"_19":268,"_21":-7},"Update instance","instance_delete",{"_15":36,"_17":264,"_19":271,"_21":-7},"Delete instance","instance_anti_affinity_group_list",{"_15":16,"_17":274,"_19":275,"_21":-7},"/v1/instances/{instance}/anti-affinity-groups","List anti-affinity groups containing instance","instance_disk_list",{"_15":16,"_17":278,"_19":279,"_21":-7},"/v1/instances/{instance}/disks","List disks for instance","instance_disk_attach",{"_15":24,"_17":282,"_19":283,"_21":-7},"/v1/instances/{instance}/disks/attach","Attach disk to instance","instance_disk_detach",{"_15":24,"_17":286,"_19":287,"_21":-7},"/v1/instances/{instance}/disks/detach","Detach disk from instance","instance_external_ip_list",{"_15":16,"_17":290,"_19":291,"_21":-7},"/v1/instances/{instance}/external-ips","List external IP addresses","instance_ephemeral_ip_attach",{"_15":24,"_17":294,"_19":295,"_21":-7},"/v1/instances/{instance}/external-ips/ephemeral","Allocate and attach ephemeral IP to instance","instance_ephemeral_ip_detach",{"_15":36,"_17":294,"_19":298,"_21":-7},"Detach and deallocate ephemeral IP from instance","instance_reboot",{"_15":24,"_17":301,"_19":302,"_21":-7},"/v1/instances/{instance}/reboot","Reboot an instance","instance_serial_console",{"_15":16,"_17":305,"_19":306,"_21":-7},"/v1/instances/{instance}/serial-console","Fetch instance serial console","instance_serial_console_stream",{"_15":16,"_17":309,"_19":310,"_21":-7},"/v1/instances/{instance}/serial-console/stream","Stream instance serial console","instance_ssh_public_key_list",{"_15":16,"_17":313,"_19":314,"_21":315},"/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","instance_start",{"_15":24,"_17":318,"_19":319,"_21":-7},"/v1/instances/{instance}/start","Boot instance","instance_stop",{"_15":24,"_17":322,"_19":323,"_21":-7},"/v1/instances/{instance}/stop","Stop instance","instance_network_interface_list",{"_15":16,"_17":326,"_19":327,"_21":-7},"/v1/network-interfaces","List network interfaces","instance_network_interface_create",{"_15":24,"_17":326,"_19":330,"_21":-7},"Create network interface","instance_network_interface_view",{"_15":16,"_17":333,"_19":334,"_21":-7},"/v1/network-interfaces/{interface}","Fetch network interface","instance_network_interface_update",{"_15":32,"_17":333,"_19":337,"_21":-7},"Update network interface","instance_network_interface_delete",{"_15":36,"_17":333,"_19":340,"_21":341},"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","login_saml",{"_15":24,"_17":344,"_19":345,"_21":-7},"/login/{silo_name}/saml/{provider_name}","Authenticate a user via SAML","login_local",{"_15":24,"_17":348,"_19":349,"_21":-7},"/v1/login/{silo_name}/local","Authenticate a user via username and password","silo_metric",{"_15":16,"_17":352,"_19":353,"_21":354},"/v1/metrics/{metric_name}","View metrics","

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

\n","system_policy_view",{"_15":16,"_17":357,"_19":358,"_21":-7},"/v1/system/policy","Fetch top-level IAM policy","system_policy_update",{"_15":32,"_17":357,"_19":361,"_21":-7},"Update top-level IAM policy","project_ip_pool_list",{"_15":16,"_17":364,"_19":365,"_21":-7},"/v1/ip-pools","List IP pools","project_ip_pool_view",{"_15":16,"_17":368,"_19":369,"_21":-7},"/v1/ip-pools/{pool}","Fetch IP pool","project_list",{"_15":16,"_17":372,"_19":373,"_21":-7},"/v1/projects","List projects","project_create",{"_15":24,"_17":372,"_19":376,"_21":-7},"Create project","project_view",{"_15":16,"_17":379,"_19":380,"_21":-7},"/v1/projects/{project}","Fetch project","project_update",{"_15":32,"_17":379,"_19":383,"_21":-7},"Update a project","project_delete",{"_15":36,"_17":379,"_19":386,"_21":-7},"Delete project","project_policy_view",{"_15":16,"_17":389,"_19":390,"_21":-7},"/v1/projects/{project}/policy","Fetch project's IAM policy","project_policy_update",{"_15":32,"_17":389,"_19":393,"_21":-7},"Update project's IAM policy","auth_settings_view",{"_15":16,"_17":396,"_19":397,"_21":-7},"/v1/auth-settings","Fetch current silo's auth settings","auth_settings_update",{"_15":32,"_17":396,"_19":400,"_21":-7},"Update current silo's auth settings","certificate_list",{"_15":16,"_17":403,"_19":404,"_21":405},"/v1/certificates","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","certificate_create",{"_15":24,"_17":403,"_19":408,"_21":409},"Create new system-wide x.509 certificate","

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

\n","certificate_view",{"_15":16,"_17":412,"_19":413,"_21":414},"/v1/certificates/{certificate}","Fetch certificate","

Returns the details of a specific certificate

\n","certificate_delete",{"_15":36,"_17":412,"_19":417,"_21":418},"Delete certificate","

Permanently delete a certificate. This operation cannot be undone.

\n","group_list",{"_15":16,"_17":421,"_19":422,"_21":-7},"/v1/groups","List groups","group_view",{"_15":16,"_17":425,"_19":426,"_21":-7},"/v1/groups/{group_id}","Fetch group","policy_view",{"_15":16,"_17":429,"_19":430,"_21":-7},"/v1/policy","Fetch current silo's IAM policy","policy_update",{"_15":32,"_17":429,"_19":433,"_21":-7},"Update current silo's IAM policy","user_list",{"_15":16,"_17":436,"_19":437,"_21":-7},"/v1/users","List users","user_view",{"_15":16,"_17":440,"_19":441,"_21":-7},"/v1/users/{user_id}","Fetch user","user_token_list",{"_15":16,"_17":444,"_19":445,"_21":-7},"/v1/users/{user_id}/access-tokens","List user's access tokens","user_logout",{"_15":24,"_17":448,"_19":449,"_21":450},"/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","user_session_list",{"_15":16,"_17":453,"_19":454,"_21":-7},"/v1/users/{user_id}/sessions","List user's console sessions","utilization_view",{"_15":16,"_17":457,"_19":458,"_21":-7},"/v1/utilization","Fetch resource utilization for user's current silo","snapshot_list",{"_15":16,"_17":461,"_19":462,"_21":-7},"/v1/snapshots","List snapshots","snapshot_create",{"_15":24,"_17":461,"_19":465,"_21":466},"Create snapshot","

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

\n","snapshot_view",{"_15":16,"_17":469,"_19":470,"_21":-7},"/v1/snapshots/{snapshot}","Fetch snapshot","snapshot_delete",{"_15":36,"_17":469,"_19":473,"_21":-7},"Delete snapshot","alert_class_list",{"_15":16,"_17":476,"_19":477,"_21":-7},"/v1/alert-classes","List alert classes","alert_receiver_list",{"_15":16,"_17":480,"_19":481,"_21":-7},"/v1/alert-receivers","List alert receivers","alert_receiver_view",{"_15":16,"_17":484,"_19":485,"_21":-7},"/v1/alert-receivers/{receiver}","Fetch alert receiver","alert_receiver_delete",{"_15":36,"_17":484,"_19":488,"_21":-7},"Delete alert receiver","alert_delivery_list",{"_15":16,"_17":491,"_19":492,"_21":493},"/v1/alert-receivers/{receiver}/deliveries","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","alert_receiver_probe",{"_15":24,"_17":496,"_19":497,"_21":498},"/v1/alert-receivers/{receiver}/probe","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","alert_receiver_subscription_add",{"_15":24,"_17":501,"_19":502,"_21":-7},"/v1/alert-receivers/{receiver}/subscriptions","Add alert receiver subscription","alert_receiver_subscription_remove",{"_15":36,"_17":505,"_19":506,"_21":-7},"/v1/alert-receivers/{receiver}/subscriptions/{subscription}","Remove alert receiver subscription","alert_delivery_resend",{"_15":24,"_17":509,"_19":510,"_21":-7},"/v1/alerts/{alert_id}/resend","Request re-delivery of alert","webhook_receiver_create",{"_15":24,"_17":513,"_19":514,"_21":-7},"/v1/webhook-receivers","Create webhook receiver","webhook_receiver_update",{"_15":32,"_17":517,"_19":518,"_21":519},"/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","webhook_secrets_list",{"_15":16,"_17":522,"_19":523,"_21":-7},"/v1/webhook-secrets","List webhook receiver secret IDs","webhook_secrets_add",{"_15":24,"_17":522,"_19":526,"_21":-7},"Add secret to webhook receiver","webhook_secrets_delete",{"_15":36,"_17":529,"_19":530,"_21":-7},"/v1/webhook-secrets/{secret_id}","Remove secret from webhook receiver","audit_log_list",{"_15":16,"_17":533,"_19":534,"_21":535},"/v1/system/audit-log","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","physical_disk_list",{"_15":16,"_17":538,"_19":539,"_21":-7},"/v1/system/hardware/disks","List physical disks","physical_disk_view",{"_15":16,"_17":542,"_19":543,"_21":-7},"/v1/system/hardware/disks/{disk_id}","Get a physical disk","rack_list",{"_15":16,"_17":546,"_19":547,"_21":-7},"/v1/system/hardware/racks","List racks","rack_view",{"_15":16,"_17":550,"_19":551,"_21":-7},"/v1/system/hardware/racks/{rack_id}","Fetch rack","sled_list",{"_15":16,"_17":554,"_19":555,"_21":-7},"/v1/system/hardware/sleds","List sleds","sled_add",{"_15":24,"_17":554,"_19":558,"_21":-7},"Add sled to initialized rack","sled_view",{"_15":16,"_17":561,"_19":562,"_21":-7},"/v1/system/hardware/sleds/{sled_id}","Fetch sled","sled_physical_disk_list",{"_15":16,"_17":565,"_19":566,"_21":-7},"/v1/system/hardware/sleds/{sled_id}/disks","List physical disks attached to sleds","sled_instance_list",{"_15":16,"_17":569,"_19":570,"_21":-7},"/v1/system/hardware/sleds/{sled_id}/instances","List instances running on given sled","sled_set_provision_policy",{"_15":32,"_17":573,"_19":574,"_21":-7},"/v1/system/hardware/sleds/{sled_id}/provision-policy","Set sled provision policy","sled_list_uninitialized",{"_15":16,"_17":577,"_19":578,"_21":-7},"/v1/system/hardware/sleds-uninitialized","List uninitialized sleds","networking_switch_port_list",{"_15":16,"_17":581,"_19":582,"_21":-7},"/v1/system/hardware/switch-port","List switch ports","networking_switch_port_apply_settings",{"_15":24,"_17":585,"_19":586,"_21":-7},"/v1/system/hardware/switch-port/{port}/settings","Apply switch port settings","networking_switch_port_clear_settings",{"_15":36,"_17":585,"_19":589,"_21":-7},"Clear switch port settings","networking_switch_port_status",{"_15":16,"_17":592,"_19":593,"_21":-7},"/v1/system/hardware/switch-port/{port}/status","Get switch port status","switch_list",{"_15":16,"_17":596,"_19":597,"_21":-7},"/v1/system/hardware/switches","List switches","switch_view",{"_15":16,"_17":600,"_19":601,"_21":-7},"/v1/system/hardware/switches/{switch_id}","Fetch switch","ip_pool_list",{"_15":16,"_17":604,"_19":365,"_21":-7},"/v1/system/ip-pools","ip_pool_create",{"_15":24,"_17":604,"_19":607,"_21":-7},"Create IP pool","ip_pool_view",{"_15":16,"_17":610,"_19":369,"_21":-7},"/v1/system/ip-pools/{pool}","ip_pool_update",{"_15":32,"_17":610,"_19":613,"_21":-7},"Update IP pool","ip_pool_delete",{"_15":36,"_17":610,"_19":616,"_21":-7},"Delete IP pool","ip_pool_range_list",{"_15":16,"_17":619,"_19":620,"_21":621},"/v1/system/ip-pools/{pool}/ranges","List ranges for IP pool","

Ranges are ordered by their first address.

\n","ip_pool_range_add",{"_15":24,"_17":624,"_19":625,"_21":626},"/v1/system/ip-pools/{pool}/ranges/add","Add range to IP pool","

IPv6 ranges are not allowed yet.

\n","ip_pool_range_remove",{"_15":24,"_17":629,"_19":630,"_21":-7},"/v1/system/ip-pools/{pool}/ranges/remove","Remove range from IP pool","ip_pool_silo_list",{"_15":16,"_17":633,"_19":634,"_21":-7},"/v1/system/ip-pools/{pool}/silos","List IP pool's linked silos","ip_pool_silo_link",{"_15":24,"_17":633,"_19":637,"_21":638},"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","ip_pool_silo_update",{"_15":32,"_17":641,"_19":642,"_21":643},"/v1/system/ip-pools/{pool}/silos/{silo}","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","ip_pool_silo_unlink",{"_15":36,"_17":641,"_19":646,"_21":647},"Unlink IP pool from silo","

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

\n","ip_pool_utilization_view",{"_15":16,"_17":650,"_19":651,"_21":-7},"/v1/system/ip-pools/{pool}/utilization","Fetch IP pool utilization","ip_pool_service_view",{"_15":16,"_17":654,"_19":655,"_21":-7},"/v1/system/ip-pools-service","Fetch Oxide service IP pool","ip_pool_service_range_list",{"_15":16,"_17":658,"_19":659,"_21":621},"/v1/system/ip-pools-service/ranges","List IP ranges for the Oxide service pool","ip_pool_service_range_add",{"_15":24,"_17":662,"_19":663,"_21":626},"/v1/system/ip-pools-service/ranges/add","Add IP range to Oxide service pool","ip_pool_service_range_remove",{"_15":24,"_17":666,"_19":667,"_21":-7},"/v1/system/ip-pools-service/ranges/remove","Remove IP range from Oxide service pool","system_metric",{"_15":16,"_17":670,"_19":353,"_21":671},"/v1/system/metrics/{metric_name}","

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

\n","system_timeseries_query",{"_15":24,"_17":674,"_19":675,"_21":676},"/v1/system/timeseries/query","Run timeseries query","

Queries are written in OxQL.

\n","system_timeseries_schema_list",{"_15":16,"_17":679,"_19":680,"_21":-7},"/v1/system/timeseries/schemas","List timeseries schemas","networking_switch_port_lldp_neighbors",{"_15":16,"_17":683,"_19":684,"_21":-7},"/v1/system/hardware/rack-switch-port/{rack_id}/{switch_location}/{port}/lldp/neighbors","Fetch the LLDP neighbors seen on a switch port","networking_switch_port_lldp_config_view",{"_15":16,"_17":687,"_19":688,"_21":-7},"/v1/system/hardware/switch-port/{port}/lldp/config","Fetch the LLDP configuration for a switch port","networking_switch_port_lldp_config_update",{"_15":24,"_17":687,"_19":691,"_21":-7},"Update the LLDP configuration for a switch port","networking_address_lot_list",{"_15":16,"_17":694,"_19":695,"_21":-7},"/v1/system/networking/address-lot","List address lots","networking_address_lot_create",{"_15":24,"_17":694,"_19":698,"_21":-7},"Create address lot","networking_address_lot_view",{"_15":16,"_17":701,"_19":702,"_21":-7},"/v1/system/networking/address-lot/{address_lot}","Fetch address lot","networking_address_lot_delete",{"_15":36,"_17":701,"_19":705,"_21":-7},"Delete address lot","networking_address_lot_block_list",{"_15":16,"_17":708,"_19":709,"_21":-7},"/v1/system/networking/address-lot/{address_lot}/blocks","List blocks in address lot","networking_allow_list_view",{"_15":16,"_17":712,"_19":713,"_21":-7},"/v1/system/networking/allow-list","Get user-facing services IP allowlist","networking_allow_list_update",{"_15":32,"_17":712,"_19":716,"_21":-7},"Update user-facing services IP allowlist","networking_bfd_disable",{"_15":24,"_17":719,"_19":720,"_21":-7},"/v1/system/networking/bfd-disable","Disable a BFD session","networking_bfd_enable",{"_15":24,"_17":723,"_19":724,"_21":-7},"/v1/system/networking/bfd-enable","Enable a BFD session","networking_bfd_status",{"_15":16,"_17":727,"_19":728,"_21":-7},"/v1/system/networking/bfd-status","Get BFD status","networking_bgp_config_list",{"_15":16,"_17":731,"_19":732,"_21":-7},"/v1/system/networking/bgp","List BGP configurations","networking_bgp_config_create",{"_15":24,"_17":731,"_19":735,"_21":-7},"Create new BGP configuration","networking_bgp_config_delete",{"_15":36,"_17":731,"_19":738,"_21":-7},"Delete BGP configuration","networking_bgp_announce_set_list",{"_15":16,"_17":741,"_19":742,"_21":-7},"/v1/system/networking/bgp-announce-set","List BGP announce sets","networking_bgp_announce_set_update",{"_15":32,"_17":741,"_19":745,"_21":746},"Update BGP announce set","

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

\n","networking_bgp_announce_set_delete",{"_15":36,"_17":749,"_19":750,"_21":-7},"/v1/system/networking/bgp-announce-set/{announce_set}","Delete BGP announce set","networking_bgp_announcement_list",{"_15":16,"_17":753,"_19":754,"_21":-7},"/v1/system/networking/bgp-announce-set/{announce_set}/announcement","Get originated routes for a specified BGP announce set","networking_bgp_exported",{"_15":16,"_17":757,"_19":758,"_21":-7},"/v1/system/networking/bgp-exported","Get BGP exported routes","networking_bgp_message_history",{"_15":16,"_17":761,"_19":762,"_21":-7},"/v1/system/networking/bgp-message-history","Get BGP router message history","networking_bgp_imported_routes_ipv4",{"_15":16,"_17":765,"_19":766,"_21":-7},"/v1/system/networking/bgp-routes-ipv4","Get imported IPv4 BGP routes","networking_bgp_status",{"_15":16,"_17":769,"_19":770,"_21":-7},"/v1/system/networking/bgp-status","Get BGP peer status","networking_inbound_icmp_view",{"_15":16,"_17":773,"_19":774,"_21":-7},"/v1/system/networking/inbound-icmp","Return whether API services can receive limited ICMP traffic","networking_inbound_icmp_update",{"_15":32,"_17":773,"_19":777,"_21":-7},"Set whether API services can receive limited ICMP traffic","networking_loopback_address_list",{"_15":16,"_17":780,"_19":781,"_21":-7},"/v1/system/networking/loopback-address","List loopback addresses","networking_loopback_address_create",{"_15":24,"_17":780,"_19":784,"_21":-7},"Create loopback address","networking_loopback_address_delete",{"_15":36,"_17":787,"_19":788,"_21":-7},"/v1/system/networking/loopback-address/{rack_id}/{switch_location}/{address}/{subnet_mask}","Delete loopback address","networking_switch_port_settings_list",{"_15":16,"_17":791,"_19":792,"_21":-7},"/v1/system/networking/switch-port-settings","List switch port settings","networking_switch_port_settings_create",{"_15":24,"_17":791,"_19":795,"_21":-7},"Create switch port settings","networking_switch_port_settings_delete",{"_15":36,"_17":791,"_19":798,"_21":-7},"Delete switch port settings","networking_switch_port_settings_view",{"_15":16,"_17":801,"_19":802,"_21":-7},"/v1/system/networking/switch-port-settings/{port}","Get information about switch port","silo_identity_provider_list",{"_15":16,"_17":805,"_19":806,"_21":807},"/v1/system/identity-providers","List identity providers for silo","

List identity providers for silo by silo name or ID.

\n","local_idp_user_create",{"_15":24,"_17":810,"_19":811,"_21":812},"/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","local_idp_user_delete",{"_15":36,"_17":815,"_19":816,"_21":-7},"/v1/system/identity-providers/local/users/{user_id}","Delete user","local_idp_user_set_password",{"_15":24,"_17":819,"_19":820,"_21":821},"/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","saml_identity_provider_create",{"_15":24,"_17":824,"_19":825,"_21":-7},"/v1/system/identity-providers/saml","Create SAML identity provider","saml_identity_provider_view",{"_15":16,"_17":828,"_19":829,"_21":-7},"/v1/system/identity-providers/saml/{provider}","Fetch SAML identity provider","scim_token_list",{"_15":16,"_17":832,"_19":833,"_21":834},"/v1/system/scim/tokens","List SCIM tokens","

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

\n","scim_token_create",{"_15":24,"_17":832,"_19":837,"_21":838},"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","scim_token_delete_all",{"_15":36,"_17":832,"_19":841,"_21":834},"Delete all SCIM tokens","scim_token_view",{"_15":16,"_17":844,"_19":845,"_21":834},"/v1/system/scim/tokens/{token_id}","Fetch SCIM token","scim_token_delete",{"_15":36,"_17":844,"_19":848,"_21":834},"Delete SCIM token","system_quotas_list",{"_15":16,"_17":851,"_19":852,"_21":-7},"/v1/system/silo-quotas","Lists resource quotas for all silos","silo_list",{"_15":16,"_17":855,"_19":856,"_21":857},"/v1/system/silos","List silos","

Lists silos that are discoverable based on the current permissions.

\n","silo_create",{"_15":24,"_17":855,"_19":860,"_21":-7},"Create a silo","silo_view",{"_15":16,"_17":863,"_19":864,"_21":865},"/v1/system/silos/{silo}","Fetch silo","

Fetch silo by name or ID.

\n","silo_delete",{"_15":36,"_17":863,"_19":868,"_21":869},"Delete a silo","

Delete a silo by name or ID.

\n","silo_ip_pool_list",{"_15":16,"_17":872,"_19":873,"_21":874},"/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","silo_policy_view",{"_15":16,"_17":877,"_19":878,"_21":-7},"/v1/system/silos/{silo}/policy","Fetch silo IAM policy","silo_policy_update",{"_15":32,"_17":877,"_19":881,"_21":-7},"Update silo IAM policy","silo_quotas_view",{"_15":16,"_17":884,"_19":885,"_21":-7},"/v1/system/silos/{silo}/quotas","Fetch resource quotas for silo","silo_quotas_update",{"_15":32,"_17":884,"_19":888,"_21":889},"Update resource quotas for silo","

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

\n","silo_user_list",{"_15":16,"_17":892,"_19":893,"_21":-7},"/v1/system/users","List built-in (system) users in silo","silo_user_view",{"_15":16,"_17":896,"_19":897,"_21":-7},"/v1/system/users/{user_id}","Fetch built-in (system) user","user_builtin_list",{"_15":16,"_17":900,"_19":901,"_21":-7},"/v1/system/users-builtin","List built-in users","user_builtin_view",{"_15":16,"_17":904,"_19":905,"_21":-7},"/v1/system/users-builtin/{user}","Fetch built-in user","silo_utilization_list",{"_15":16,"_17":908,"_19":909,"_21":-7},"/v1/system/utilization/silos","List current utilization state for all silos","silo_utilization_view",{"_15":16,"_17":912,"_19":913,"_21":-7},"/v1/system/utilization/silos/{silo}","Fetch current utilization for given silo","ping",{"_15":16,"_17":916,"_19":917,"_21":918},"/v1/ping","Ping API","

Always responds with Ok if it responds at all.

\n","system_update_repository_list",{"_15":16,"_17":921,"_19":922,"_21":923},"/v1/system/update/repositories","List all TUF repositories","

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

\n","system_update_repository_upload",{"_15":32,"_17":921,"_19":926,"_21":927},"Upload system release repository","

System release repositories are verified by the updates trust store.

\n","system_update_repository_view",{"_15":16,"_17":930,"_19":931,"_21":-7},"/v1/system/update/repositories/{system_version}","Fetch system release repository description by version","system_update_status",{"_15":16,"_17":934,"_19":935,"_21":936},"/v1/system/update/status","Fetch system update status","

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

\n","target_release_update",{"_15":32,"_17":939,"_19":940,"_21":941},"/v1/system/update/target-release","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","system_update_trust_root_list",{"_15":16,"_17":944,"_19":945,"_21":946},"/v1/system/update/trust-roots","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","system_update_trust_root_create",{"_15":24,"_17":944,"_19":949,"_21":-7},"Add trusted root role to updates trust store","system_update_trust_root_view",{"_15":16,"_17":952,"_19":953,"_21":-7},"/v1/system/update/trust-roots/{trust_root_id}","Fetch trusted root role","system_update_trust_root_delete",{"_15":36,"_17":952,"_19":956,"_21":957},"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","current_user_access_token_list",{"_15":16,"_17":960,"_19":961,"_21":962},"/v1/me/access-tokens","List access tokens","

List device access tokens for the currently authenticated user.

\n","current_user_access_token_delete",{"_15":36,"_17":965,"_19":966,"_21":967},"/v1/me/access-tokens/{token_id}","Delete access token","

Delete a device access token for the currently authenticated user.

\n","internet_gateway_ip_address_list",{"_15":16,"_17":970,"_19":971,"_21":-7},"/v1/internet-gateway-ip-addresses","List IP addresses attached to internet gateway","internet_gateway_ip_address_create",{"_15":24,"_17":970,"_19":974,"_21":-7},"Attach IP address to internet gateway","internet_gateway_ip_address_delete",{"_15":36,"_17":977,"_19":978,"_21":-7},"/v1/internet-gateway-ip-addresses/{address}","Detach IP address from internet gateway","internet_gateway_ip_pool_list",{"_15":16,"_17":981,"_19":982,"_21":-7},"/v1/internet-gateway-ip-pools","List IP pools attached to internet gateway","internet_gateway_ip_pool_create",{"_15":24,"_17":981,"_19":985,"_21":-7},"Attach IP pool to internet gateway","internet_gateway_ip_pool_delete",{"_15":36,"_17":988,"_19":989,"_21":-7},"/v1/internet-gateway-ip-pools/{pool}","Detach IP pool from internet gateway","internet_gateway_list",{"_15":16,"_17":992,"_19":993,"_21":-7},"/v1/internet-gateways","List internet gateways","internet_gateway_create",{"_15":24,"_17":992,"_19":996,"_21":-7},"Create VPC internet gateway","internet_gateway_view",{"_15":16,"_17":999,"_19":1000,"_21":-7},"/v1/internet-gateways/{gateway}","Fetch internet gateway","internet_gateway_delete",{"_15":36,"_17":999,"_19":1003,"_21":-7},"Delete internet gateway","vpc_firewall_rules_view",{"_15":16,"_17":1006,"_19":1007,"_21":-7},"/v1/vpc-firewall-rules","List firewall rules","vpc_firewall_rules_update",{"_15":32,"_17":1006,"_19":1010,"_21":1011},"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","vpc_router_route_list",{"_15":16,"_17":1014,"_19":1015,"_21":1016},"/v1/vpc-router-routes","List routes","

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

\n","vpc_router_route_create",{"_15":24,"_17":1014,"_19":1019,"_21":-7},"Create route","vpc_router_route_view",{"_15":16,"_17":1022,"_19":1023,"_21":-7},"/v1/vpc-router-routes/{route}","Fetch route","vpc_router_route_update",{"_15":32,"_17":1022,"_19":1026,"_21":-7},"Update route","vpc_router_route_delete",{"_15":36,"_17":1022,"_19":1029,"_21":-7},"Delete route","vpc_router_list",{"_15":16,"_17":1032,"_19":1033,"_21":-7},"/v1/vpc-routers","List routers","vpc_router_create",{"_15":24,"_17":1032,"_19":1036,"_21":-7},"Create VPC router","vpc_router_view",{"_15":16,"_17":1039,"_19":1040,"_21":-7},"/v1/vpc-routers/{router}","Fetch router","vpc_router_update",{"_15":32,"_17":1039,"_19":1043,"_21":-7},"Update router","vpc_router_delete",{"_15":36,"_17":1039,"_19":1046,"_21":-7},"Delete router","vpc_subnet_list",{"_15":16,"_17":1049,"_19":1050,"_21":-7},"/v1/vpc-subnets","List subnets","vpc_subnet_create",{"_15":24,"_17":1049,"_19":1053,"_21":-7},"Create subnet","vpc_subnet_view",{"_15":16,"_17":1056,"_19":1057,"_21":-7},"/v1/vpc-subnets/{subnet}","Fetch subnet","vpc_subnet_update",{"_15":32,"_17":1056,"_19":1060,"_21":-7},"Update subnet","vpc_subnet_delete",{"_15":36,"_17":1056,"_19":1063,"_21":-7},"Delete subnet","vpc_subnet_list_network_interfaces",{"_15":16,"_17":1066,"_19":327,"_21":-7},"/v1/vpc-subnets/{subnet}/network-interfaces","vpc_list",{"_15":16,"_17":1069,"_19":1070,"_21":-7},"/v1/vpcs","List VPCs","vpc_create",{"_15":24,"_17":1069,"_19":1073,"_21":-7},"Create VPC","vpc_view",{"_15":16,"_17":1076,"_19":1077,"_21":-7},"/v1/vpcs/{vpc}","Fetch VPC","vpc_update",{"_15":32,"_17":1076,"_19":1080,"_21":-7},"Update a VPC","vpc_delete",{"_15":36,"_17":1076,"_19":1083,"_21":-7},"Delete VPC","routes/cli",{"_1086":1087,"_4448":4449,"_1090":1091,"_4457":4458},"docs",{"_1088":1089,"_1090":1091,"_1092":1093,"_1094":1095,"_1121":1122},"name","oxide","version","0.13.0+20250730.0.0","about","

Control an Oxide environment

\n","args",[1096,1101,1104,1107,1110,1115,1118],{"_1097":1098,"_1099":1100},"long","cacert","help","Specify a trusted CA cert",{"_1097":1102,"_1099":1103},"config-dir","Directory to use for configuration",{"_1097":1105,"_1099":1106},"debug","Enable debug output",{"_1097":1108,"_1099":1109},"insecure","Disable certificate validation and hostname verification",{"_1097":1111,"_1099":1112,"_1113":1114},"profile","Configuration profile to use for commands","global",true,{"_1097":1116,"_1099":1117},"resolve","Modify name resolution",{"_1097":1119,"_1099":1120},"timeout","Timeout value for individual API invocations","subcommands",[1123,1295,1332,1350,1394,1412,1480,1522,1538,1608,1725,1729,1926,2000,2012,2065,2473,2598,2757,2761,2775,2843,2876,3113,3149,4152,4193,4197,4201],{"_1088":1124,"_1094":1125,"_1121":1127},"alert",[1126],{"_1097":1111,"_1099":1112,"_1113":1114},[1128,1144],{"_1088":1129,"_1094":1130,"_1121":1132},"class",[1131],{"_1097":1111,"_1099":1112,"_1113":1114},[1133],{"_1088":1134,"_1092":1135,"_1094":1136},"list","

List alert classes

\n",[1137,1140,1143],{"_1097":1138,"_1099":1139},"filter","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.",{"_1097":1141,"_1099":1142},"limit","Maximum number of items returned by a single call",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1145,"_1094":1146,"_1121":1148},"receiver",[1147],{"_1097":1111,"_1099":1112,"_1113":1114},[1149,1155,1167,1193,1203,1211,1226,1234,1240],{"_1088":36,"_1092":1150,"_1094":1151},"

Delete alert receiver

\n",[1152,1153],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},"The name or ID of the webhook receiver.",{"_1088":1134,"_1092":1156,"_1094":1157},"

List alert receivers

\n",[1158,1159,1160],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":1163},"sort-by","values",[1164,1165,1166],"name_ascending","name_descending","id_ascending",{"_1088":1168,"_1092":1169,"_1170":493,"_1094":1171},"log","

List delivery attempts to alert receiver

\n","long_about",[1172,1178,1182,1183,1187,1188,1189],{"_1097":1173,"_1162":1174,"_1099":1177},"delivered",[1175,1176],"true","false","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.",{"_1097":1179,"_1162":1180,"_1099":1181},"failed",[1175,1176],"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.",{"_1097":1141,"_1099":1142},{"_1097":1184,"_1162":1185,"_1099":1186},"pending",[1175,1176],"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.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1097":1161,"_1162":1190},[1191,1192],"time_and_id_ascending","time_and_id_descending",{"_1088":1194,"_1092":1195,"_1170":498,"_1094":1196},"probe","

Send liveness probe to alert receiver

\n",[1197,1198,1199],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1097":1200,"_1162":1201,"_1099":1202},"resend",[1175,1176],"If true, resend all events that have not been delivered successfully if the probe request succeeds.",{"_1088":1200,"_1092":1204,"_1094":1205},"

Request re-delivery of alert

\n",[1206,1209,1210],{"_1097":1207,"_1099":1208},"alert-id","UUID of the alert",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1088":1212,"_1092":1213,"_1094":1214},"subscribe","

Add alert receiver subscription

\n",[1215,1218,1221,1222,1223],{"_1097":1216,"_1099":1217},"json-body","Path to a file that contains the full json body.",{"_1097":1219,"_1099":1220},"json-body-template","XXX",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1097":1224,"_1099":1225},"subscription","The event class pattern to subscribe to.",{"_1088":1227,"_1092":1228,"_1094":1229},"unsubscribe","

Remove alert receiver subscription

\n",[1230,1231,1232],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1097":1224,"_1099":1233},"The event class subscription itself.",{"_1088":1235,"_1092":1236,"_1094":1237},"view","

Fetch alert receiver

\n",[1238,1239],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1088":1241,"_1094":1242,"_1121":1244},"webhook",[1243],{"_1097":1111,"_1099":1112,"_1113":1114},[1245,1257,1284],{"_1088":1246,"_1092":1247,"_1094":1248},"create","

Create webhook receiver

\n",[1249,1250,1253,1254,1255,1256],{"_1097":21},{"_1097":1251,"_1099":1252},"endpoint","The URL that webhook notification requests should be sent to",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1258,"_1094":1259,"_1121":1261},"secret",[1260],{"_1097":1111,"_1099":1112,"_1113":1114},[1262,1272,1279],{"_1088":1263,"_1092":1264,"_1094":1265},"add","

Add secret to webhook receiver

\n",[1266,1267,1268,1269,1270],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1097":1258,"_1099":1271},"The value of the shared secret key.",{"_1088":36,"_1092":1273,"_1094":1274},"

Remove secret from webhook receiver

\n",[1275,1276],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1277,"_1099":1278},"secret-id","ID of the secret.",{"_1088":1134,"_1092":1280,"_1094":1281},"

List webhook receiver secret IDs

\n",[1282,1283],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1088":1285,"_1092":1286,"_1170":519,"_1094":1287},"update","

Update webhook receiver

\n",[1288,1289,1290,1291,1292,1293,1294],{"_1097":21},{"_1097":1251,"_1099":1252},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1145,"_1099":1154},{"_1088":1296,"_1092":1297,"_1170":1298,"_1094":1299},"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",[1300,1305,1309,1313,1316,1318,1322,1325,1326,1330],{"_1097":1301,"_1302":1303,"_1099":1304},"field","short","F","Add a typed parameter in key=value format",{"_1097":1306,"_1302":1307,"_1099":1308},"header","H","Add a HTTP request header in `key:value` format",{"_1097":1310,"_1302":1311,"_1099":1312},"include","i","Include HTTP response headers in the output",{"_1097":1314,"_1099":1315},"input","The file to use as body for the HTTP request (use \"-\" to read from standard input)",{"_1097":1141,"_1099":1317},"Limit the number of paginated items retrieved",{"_1097":1319,"_1302":1320,"_1099":1321},"method","X","The HTTP method for the request",{"_1097":1323,"_1099":1324},"paginate","Make additional HTTP requests to fetch all pages of results",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1327,"_1302":1328,"_1099":1329},"raw-field","f","Add a string parameter in key=value format",{"_1088":1251,"_1099":1331},"The endpoint to request",{"_1088":1333,"_1094":1334,"_1121":1336},"audit-log",[1335],{"_1097":1111,"_1099":1112,"_1113":1114},[1337],{"_1088":1134,"_1092":1338,"_1170":535,"_1094":1339},"

View audit log

\n",[1340,1343,1344,1345,1347],{"_1097":1341,"_1099":1342},"end-time","Exclusive",{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":1346},[1191,1192],{"_1097":1348,"_1099":1349},"start-time","Required, inclusive",{"_1088":1351,"_1092":1352,"_1170":1353,"_1094":1354,"_1121":1356},"auth","

\n","

Manage oxide's authentication state.

\n",[1355],{"_1097":1111,"_1099":1112,"_1113":1114},[1357,1375,1388],{"_1088":1358,"_1092":1359,"_1170":1360,"_1094":1361},"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",[1362,1365,1368,1371,1372],{"_1097":1363,"_1099":1364},"browser","Override the default browser when opening the authentication URL",{"_1097":1366,"_1302":1307,"_1099":1367},"host","The host of the Oxide instance to authenticate with. This assumes https; specify an `http://` prefix if needed",{"_1097":1369,"_1099":1370},"no-browser","Print the authentication URL rather than opening a browser window",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1373,"_1099":1374},"time-to-live","Lifetime of login. If not specified, the silo's policy is used. Specify units e.g. 7d, 2w, 6M, 1y",{"_1088":1376,"_1092":1377,"_1170":1378,"_1094":1379},"logout","

Removes saved authentication information from profiles.

\n","

Removes saved authentication information from profiles.

This command does not invalidate any tokens.

\n",[1380,1384,1387],{"_1097":1381,"_1302":1382,"_1099":1383},"all","a","If set, authentication information from all profiles will be deleted",{"_1097":1385,"_1302":1328,"_1099":1386},"force","Skip confirmation prompt",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1389,"_1092":1390,"_1170":1391,"_1094":1392},"status","

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",[1393],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1395,"_1094":1396,"_1121":1398},"auth-settings",[1397],{"_1097":1111,"_1099":1112,"_1113":1114},[1399,1408],{"_1088":1285,"_1092":1400,"_1094":1401},"

Update current silo's auth settings

\n",[1402,1405,1406,1407],{"_1097":1403,"_1099":1404},"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.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":1409,"_1094":1410},"

Fetch current silo's auth settings

\n",[1411],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1413,"_1094":1414,"_1121":1416},"bundle",[1415],{"_1097":1111,"_1099":1112,"_1113":1114},[1417,1426,1433,1449,1460,1467,1475],{"_1088":1246,"_1092":1418,"_1094":1419},"

Create a new support bundle

\n",[1420,1421,1422,1423],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1424,"_1099":1425},"user-comment","User comment for the support bundle",{"_1088":36,"_1092":1427,"_1170":141,"_1094":1428},"

Delete an existing support bundle

\n",[1429,1432],{"_1097":1430,"_1099":1431},"bundle-id","ID of the support bundle",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1434,"_1092":1435,"_1094":1436},"download","

Downloads a support bundle

\n",[1437,1441,1444,1448],{"_1097":1438,"_1302":1439,"_1099":1440},"chunk-size","c","The size, in bytes, of each range request to use when downloading bundles",{"_1097":1442,"_1099":1443},"id","ID of the bundle",{"_1097":1445,"_1302":1446,"_1099":1447},"output","o","Path where the bundle should be downloaded",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1450,"_1092":1451,"_1170":1452,"_1094":1453},"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",[1454,1456,1459],{"_1097":1442,"_1099":1455},"ID of the bundle to be inspected, if accessing via API",{"_1097":17,"_1302":1457,"_1099":1458},"p","Path of the bundle to inspect, if downloaded",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":1461,"_1094":1462},"

List all support bundles

\n",[1463,1464,1465],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":1466},[1191,1192],{"_1088":1285,"_1092":1468,"_1094":1469},"

Update a support bundle

\n",[1470,1471,1472,1473,1474],{"_1097":1430,"_1099":1431},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1424,"_1099":1425},{"_1088":1235,"_1092":1476,"_1094":1477},"

View a support bundle

\n",[1478,1479],{"_1097":1430,"_1099":1431},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1481,"_1094":1482,"_1121":1484},"certificate",[1483],{"_1097":1111,"_1099":1112,"_1113":1114},[1485,1504,1510,1517],{"_1088":1246,"_1092":1486,"_1170":409,"_1094":1487},"

Create new system-wide x.509 certificate

\n",[1488,1491,1492,1493,1494,1497,1498,1499],{"_1097":1489,"_1099":1490},"cert","PEM-formatted string containing public certificate chain",{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1495,"_1099":1496},"key","PEM-formatted string containing private key",{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1500,"_1162":1501,"_1099":1503},"service",[1502],"external_api","The service using this certificate",{"_1088":36,"_1092":1505,"_1170":418,"_1094":1506},"

Delete certificate

\n",[1507,1509],{"_1097":1481,"_1099":1508},"Name or ID of the certificate",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":1511,"_1170":405,"_1094":1512},"

List certificates for external endpoints

\n",[1513,1514,1515],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":1516},[1164,1165,1166],{"_1088":1235,"_1092":1518,"_1170":414,"_1094":1519},"

Fetch certificate

\n",[1520,1521],{"_1097":1481,"_1099":1508},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1523,"_1092":1524,"_1170":1525,"_1094":1526},"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",[1527,1528],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1529,"_1302":1530,"_1162":1531,"_1099":1537},"shell","s",[1532,1533,1534,1535,1536],"bash","elvish","fish","powershell","zsh","Shell type",{"_1088":1539,"_1094":1540,"_1121":1542},"current-user",[1541],{"_1097":1111,"_1099":1112,"_1113":1114},[1543,1562,1570,1604],{"_1088":1544,"_1094":1545,"_1121":1547},"access-token",[1546],{"_1097":1111,"_1099":1112,"_1113":1114},[1548,1555],{"_1088":36,"_1092":1549,"_1170":967,"_1094":1550},"

Delete access token

\n",[1551,1552],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1553,"_1099":1554},"token-id","ID of the token",{"_1088":1134,"_1092":1556,"_1170":962,"_1094":1557},"

List access tokens

\n",[1558,1559,1560],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":1561},[1166],{"_1088":1563,"_1092":1564,"_1094":1565},"groups","

Fetch current user's groups

\n",[1566,1567,1568],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":1569},[1166],{"_1088":1571,"_1094":1572,"_1121":1574},"ssh-key",[1573],{"_1097":1111,"_1099":1112,"_1113":1114},[1575,1586,1592,1599],{"_1088":1246,"_1092":1576,"_1170":68,"_1094":1577},"

Create SSH public key

\n",[1578,1579,1580,1581,1582,1583],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1584,"_1099":1585},"public-key","SSH public key, e.g., `\"ssh-ed25519 AAAAC3NzaC...\"`",{"_1088":36,"_1092":1587,"_1170":77,"_1094":1588},"

Delete SSH public key

\n",[1589,1590],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1571,"_1099":1591},"Name or ID of the SSH key",{"_1088":1134,"_1092":1593,"_1170":64,"_1094":1594},"

List SSH public keys

\n",[1595,1596,1597],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":1598},[1164,1165,1166],{"_1088":1235,"_1092":1600,"_1170":73,"_1094":1601},"

Fetch SSH public key

\n",[1602,1603],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1571,"_1099":1591},{"_1088":1235,"_1092":1605,"_1094":1606},"

Fetch user for current session

\n",[1607],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1609,"_1094":1610,"_1121":1612},"disk",[1611],{"_1097":1111,"_1099":1112,"_1113":1114},[1613,1627,1634,1711,1719],{"_1088":1246,"_1092":1614,"_1094":1615},"

Create a disk

\n",[1616,1617,1618,1619,1620,1621,1624],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},"project","Name or ID of the project",{"_1097":1625,"_1099":1626},"size","The total size of the Disk; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib",{"_1088":36,"_1092":1628,"_1094":1629},"

Delete disk

\n",[1630,1632,1633],{"_1097":1609,"_1099":1631},"Name or ID of the disk",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1635,"_1092":1636,"_1170":1637,"_1094":1638,"_1121":1671},"import","

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",[1639,1640,1642,1649,1652,1655,1658,1661,1664,1666,1667,1668],{"_1097":21},{"_1097":1609,"_1099":1641},"The name of the disk to create",{"_1097":1643,"_1162":1644,"_1099":1648},"disk-block-size",[1645,1646,1647],"512","2048","4096","The desired size of the disk's blocks",{"_1097":1650,"_1099":1651},"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",{"_1097":1653,"_1099":1654},"image","If supplied, create an image with the given name. Requires the creation of a snapshot",{"_1097":1656,"_1099":1657},"image-description","The description for the image created out of the snapshot of this disk",{"_1097":1659,"_1099":1660},"image-os","The OS of this image (e.g. Debian)",{"_1097":1662,"_1099":1663},"image-version","The version of this image (e.g. 11, focal, a9e77e3a, 2023-04-06T14:23:34Z)",{"_1097":17,"_1099":1665},"Path to the file to import",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1669,"_1099":1670},"snapshot","If supplied, create a snapshot with the given name",[1672,1684,1691,1698],{"_1088":1673,"_1092":1674,"_1094":1675},"finalize","

Confirm disk block import completion

\n",[1676,1677,1678,1679,1680,1681],{"_1097":1609,"_1099":1631},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1682,"_1099":1683},"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.",{"_1088":1685,"_1092":1686,"_1170":100,"_1094":1687},"start","

Start importing blocks into disk

\n",[1688,1689,1690],{"_1097":1609,"_1099":1631},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1692,"_1092":1693,"_1170":105,"_1094":1694},"stop","

Stop importing blocks into disk

\n",[1695,1696,1697],{"_1097":1609,"_1099":1631},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1699,"_1092":1700,"_1094":1701},"write","

Import blocks into disk

\n",[1702,1704,1705,1706,1707,1709,1710],{"_1097":1703},"base64-encoded-data",{"_1097":1609,"_1099":1631},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1708},"offset",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":1712,"_1094":1713},"

List disks

\n",[1714,1715,1716,1717],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":1718},[1164,1165,1166],{"_1088":1235,"_1092":1720,"_1094":1721},"

Fetch disk

\n",[1722,1723,1724],{"_1097":1609,"_1099":1631},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1086,"_1092":1726,"_1094":1727},"

Generate CLI docs in JSON format

\n",[1728],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1730,"_1094":1731,"_1121":1733},"experimental",[1732],{"_1097":1111,"_1099":1112,"_1113":1114},[1734,1832,1902],{"_1088":1735,"_1094":1736,"_1121":1738},"instance",[1737],{"_1097":1111,"_1099":1112,"_1113":1114},[1739],{"_1088":1740,"_1094":1741,"_1121":1743},"affinity",[1742],{"_1097":1111,"_1099":1112,"_1113":1114},[1744,1762,1770,1778,1816,1826],{"_1088":1246,"_1092":1745,"_1094":1746},"

Create affinity group

\n",[1747,1748,1752,1753,1754,1755,1760,1761],{"_1097":21},{"_1097":1749,"_1162":1750},"failure-domain",[1751],"sled",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1756,"_1162":1757},"policy",[1758,1759],"allow","fail",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":36,"_1092":1763,"_1094":1764},"

Delete affinity group

\n",[1765,1768,1769],{"_1097":1766,"_1099":1767},"affinity-group","Name or ID of the affinity group",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":1771,"_1094":1772},"

List affinity groups

\n",[1773,1774,1775,1776],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":1777},[1164,1165,1166],{"_1088":1779,"_1094":1780,"_1121":1782},"member",[1781],{"_1097":1111,"_1099":1112,"_1113":1114},[1783,1791,1800,1808],{"_1088":1784,"_1092":1785,"_1094":1786},"add-instance","

Add member to affinity group

\n",[1787,1788,1789,1790],{"_1097":1766},{"_1097":1735},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":1792,"_1094":1793},"

List affinity group members

\n",[1794,1795,1796,1797,1798],{"_1097":1766,"_1099":1767},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":1799},[1164,1165,1166],{"_1088":1801,"_1092":1802,"_1094":1803},"remove-instance","

Remove member from affinity group

\n",[1804,1805,1806,1807],{"_1097":1766},{"_1097":1735},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1809,"_1092":1810,"_1094":1811},"view-instance","

Fetch affinity group member

\n",[1812,1813,1814,1815],{"_1097":1766},{"_1097":1735},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1285,"_1092":1817,"_1094":1818},"

Update affinity group

\n",[1819,1820,1821,1822,1823,1824,1825],{"_1097":1766,"_1099":1767},{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1235,"_1092":1827,"_1094":1828},"

Fetch affinity group

\n",[1829,1830,1831],{"_1097":1766,"_1099":1767},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1833,"_1094":1834,"_1121":1836},"system",[1835],{"_1097":1111,"_1099":1112,"_1113":1114},[1837,1874],{"_1088":1194,"_1094":1838,"_1121":1840},[1839],{"_1097":1111,"_1099":1112,"_1113":1114},[1841,1853,1860,1868],{"_1088":1246,"_1092":1842,"_1094":1843},"

Create instrumentation probe

\n",[1844,1845,1847,1848,1849,1850,1851,1852],{"_1097":21},{"_1097":1846},"ip-pool",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1751},{"_1088":36,"_1092":1854,"_1094":1855},"

Delete instrumentation probe

\n",[1856,1858,1859],{"_1097":1194,"_1099":1857},"Name or ID of the probe",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":1861,"_1094":1862},"

List instrumentation probes

\n",[1863,1864,1865,1866],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":1867},[1164,1165,1166],{"_1088":1235,"_1092":1869,"_1094":1870},"

View instrumentation probe

\n",[1871,1872,1873],{"_1097":1194,"_1099":1857},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1875,"_1094":1876,"_1121":1878},"timeseries",[1877],{"_1097":1111,"_1099":1112,"_1113":1114},[1879,1892],{"_1088":1880,"_1092":1881,"_1170":676,"_1094":1882},"query","

Run timeseries query

\n",[1883,1887,1888,1889,1890],{"_1097":1884,"_1162":1885,"_1099":1886},"include-summaries",[1175,1176],"Whether to include ClickHouse query summaries in the response.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1880,"_1099":1891},"A timeseries query string, written in the Oximeter query language.",{"_1088":1893,"_1094":1894,"_1121":1896},"schema",[1895],{"_1097":1111,"_1099":1112,"_1113":1114},[1897],{"_1088":1134,"_1092":1898,"_1094":1899},"

List timeseries schemas

\n",[1900,1901],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1875,"_1094":1903,"_1121":1905},[1904],{"_1097":1111,"_1099":1112,"_1113":1114},[1906,1916],{"_1088":1907,"_1092":1908,"_1094":1909},"dashboard","

Graph the results of an OxQL timeseries query.

\n",[1910,1913,1914],{"_1097":1911,"_1302":1311,"_1099":1912},"interval","The interval on which to update the dashboard display, in seconds",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1880,"_1099":1915},"The timeseries query to display in the dashboard",{"_1088":1880,"_1092":1917,"_1170":200,"_1094":1918},"

Run project-scoped timeseries query

\n",[1919,1921,1922,1923,1924,1925],{"_1097":1884,"_1162":1920,"_1099":1886},[1175,1176],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1880,"_1099":1891},{"_1088":1927,"_1094":1928,"_1121":1930},"floating-ip",[1929],{"_1097":1111,"_1099":1112,"_1113":1114},[1931,1948,1963,1969,1976,1984,1994],{"_1088":1932,"_1092":1933,"_1170":222,"_1094":1934},"attach","

Attach floating IP

\n",[1935,1937,1938,1939,1943,1946,1947],{"_1097":1927,"_1099":1936},"Name or ID of the floating IP",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1940,"_1162":1941,"_1099":1942},"kind",[1735],"The type of `parent`'s resource",{"_1097":1944,"_1099":1945},"parent","Name or ID of the resource that this IP address should be attached to",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1246,"_1092":1949,"_1094":1950},"

Create floating IP

\n",[1951,1952,1955,1956,1957,1958,1961,1962],{"_1097":21},{"_1097":1953,"_1099":1954},"ip","An IP address to reserve for use as a floating IP. This field is optional: when not set, an address will be automatically chosen from `pool`. If set, then the IP must be available in the resolved `pool`.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1959,"_1099":1960},"pool","The parent IP pool that a floating IP is pulled from. If unset, the default pool is selected.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":36,"_1092":1964,"_1094":1965},"

Delete floating IP

\n",[1966,1967,1968],{"_1097":1927,"_1099":1936},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1970,"_1092":1971,"_1094":1972},"detach","

Detach floating IP

\n",[1973,1974,1975],{"_1097":1927,"_1099":1936},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":1977,"_1094":1978},"

List floating IPs

\n",[1979,1980,1981,1982],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":1983},[1164,1165,1166],{"_1088":1285,"_1092":1985,"_1094":1986},"

Update floating IP

\n",[1987,1988,1989,1990,1991,1992,1993],{"_1097":21},{"_1097":1927,"_1099":1936},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1235,"_1092":1995,"_1094":1996},"

Fetch floating IP

\n",[1997,1998,1999],{"_1097":1927,"_1099":1936},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":2001,"_1094":2002,"_1121":2004},"group",[2003],{"_1097":1111,"_1099":1112,"_1113":1114},[2005],{"_1088":1134,"_1092":2006,"_1094":2007},"

List groups

\n",[2008,2009,2010],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":2011},[1166],{"_1088":1653,"_1094":2013,"_1121":2015},[2014],{"_1097":1111,"_1099":1112,"_1113":1114},[2016,2030,2037,2044,2052,2059],{"_1088":1246,"_1092":2017,"_1170":235,"_1094":2018},"

Create image

\n",[2019,2020,2021,2022,2023,2026,2027,2028],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":2024,"_1099":2025},"os","The family of the operating system (e.g. Debian, Ubuntu, etc.)",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1090,"_1099":2029},"The version of the operating system (e.g. 18.04, 20.04, etc.)",{"_1088":36,"_1092":2031,"_1170":244,"_1094":2032},"

Delete image

\n",[2033,2035,2036],{"_1097":1653,"_1099":2034},"Name or ID of the image",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":2038,"_1092":2039,"_1170":249,"_1094":2040},"demote","

Demote silo image

\n",[2041,2042,2043],{"_1097":1653,"_1099":2034},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":2045,"_1170":231,"_1094":2046},"

List images

\n",[2047,2048,2049,2050],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":2051},[1164,1165,1166],{"_1088":2053,"_1092":2054,"_1170":254,"_1094":2055},"promote","

Promote project image

\n",[2056,2057,2058],{"_1097":1653,"_1099":2034},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1235,"_1092":2060,"_1170":240,"_1094":2061},"

Fetch image

\n",[2062,2063,2064],{"_1097":1653,"_1099":2034},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1735,"_1094":2066,"_1121":2068},[2067],{"_1097":1111,"_1099":1112,"_1113":1114},[2069,2153,2189,2196,2227,2256,2278,2286,2350,2382,2389,2437,2443,2449,2467],{"_1088":2070,"_1094":2071,"_1121":2073},"anti-affinity",[2072],{"_1097":1111,"_1099":1112,"_1113":1114},[2074,2087,2095,2103,2137,2147],{"_1088":1246,"_1092":2075,"_1094":2076},"

Create anti-affinity group

\n",[2077,2078,2080,2081,2082,2083,2085,2086],{"_1097":21},{"_1097":1749,"_1162":2079},[1751],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1756,"_1162":2084},[1758,1759],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":36,"_1092":2088,"_1094":2089},"

Delete anti-affinity group

\n",[2090,2093,2094],{"_1097":2091,"_1099":2092},"anti-affinity-group","Name or ID of the anti affinity group",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":2096,"_1094":2097},"

List anti-affinity groups

\n",[2098,2099,2100,2101],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":2102},[1164,1165,1166],{"_1088":1779,"_1094":2104,"_1121":2106},[2105],{"_1097":1111,"_1099":1112,"_1113":1114},[2107,2114,2123,2130],{"_1088":1784,"_1092":2108,"_1094":2109},"

Add member to anti-affinity group

\n",[2110,2111,2112,2113],{"_1097":2091},{"_1097":1735},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":2115,"_1094":2116},"

List anti-affinity group members

\n",[2117,2118,2119,2120,2121],{"_1097":2091,"_1099":2092},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":2122},[1164,1165,1166],{"_1088":1801,"_1092":2124,"_1094":2125},"

Remove member from anti-affinity group

\n",[2126,2127,2128,2129],{"_1097":2091},{"_1097":1735},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1809,"_1092":2131,"_1094":2132},"

Fetch anti-affinity group member

\n",[2133,2134,2135,2136],{"_1097":2091},{"_1097":1735},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1285,"_1092":2138,"_1094":2139},"

Update anti-affinity group

\n",[2140,2141,2142,2143,2144,2145,2146],{"_1097":2091,"_1099":2092},{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1235,"_1092":2148,"_1094":2149},"

Fetch anti-affinity group

\n",[2150,2151,2152],{"_1097":2091,"_1099":2092},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1246,"_1092":2154,"_1094":2155},"

Create instance

\n",[2156,2162,2168,2169,2172,2173,2174,2177,2178,2181,2182,2183,2186],{"_1097":2157,"_1162":2158,"_1099":2161},"auto-restart-policy",[2159,2160],"never","best_effort","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`.",{"_1097":2163,"_1162":2164,"_1099":2167},"cpu-platform",[2165,2166],"amd_milan","amd_turin","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.",{"_1097":21},{"_1097":2170,"_1099":2171},"hostname","The hostname to be assigned to the instance",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2175,"_1099":2176},"memory","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",{"_1097":1088},{"_1097":2179,"_1099":2180},"ncpus","The number of vCPUs to be allocated to the instance",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1685,"_1162":2184,"_1099":2185},[1175,1176],"Should this instance be started upon creation; true by default.",{"_1097":2187,"_1099":2188},"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.",{"_1088":36,"_1092":2190,"_1094":2191},"

Delete instance

\n",[2192,2194,2195],{"_1097":1735,"_1099":2193},"Name or ID of the instance",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1609,"_1094":2197,"_1121":2199},[2198],{"_1097":1111,"_1099":1112,"_1113":1114},[2200,2209,2218],{"_1088":1932,"_1092":2201,"_1094":2202},"

Attach disk to instance

\n",[2203,2204,2205,2206,2207,2208],{"_1097":1609,"_1099":1631},{"_1097":1735,"_1099":2193},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1970,"_1092":2210,"_1094":2211},"

Detach disk from instance

\n",[2212,2213,2214,2215,2216,2217],{"_1097":1609,"_1099":1631},{"_1097":1735,"_1099":2193},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":2219,"_1094":2220},"

List disks for instance

\n",[2221,2222,2223,2224,2225],{"_1097":1735,"_1099":2193},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":2226},[1164,1165,1166],{"_1088":2228,"_1094":2229,"_1121":2231},"external-ip",[2230],{"_1097":1111,"_1099":1112,"_1113":1114},[2232,2243,2250],{"_1088":2233,"_1092":2234,"_1094":2235},"attach-ephemeral","

Allocate and attach ephemeral IP to instance

\n",[2236,2237,2238,2239,2241,2242],{"_1097":1735,"_1099":2193},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1959,"_1099":2240},"Name or ID of the IP pool used to allocate an address. If unspecified, the default IP pool will be used.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":2244,"_1092":2245,"_1094":2246},"detach-ephemeral","

Detach and deallocate ephemeral IP from instance

\n",[2247,2248,2249],{"_1097":1735,"_1099":2193},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1134,"_1092":2251,"_1094":2252},"

List external IP addresses

\n",[2253,2254,2255],{"_1097":1735,"_1099":2193},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":2257,"_1092":2258,"_1094":2259},"from-image","

Launch an instance from a disk image.

\n",[2260,2262,2263,2265,2267,2269,2271,2272,2274,2276],{"_1097":21,"_1099":2261},"Description of the instance",{"_1097":2170,"_1099":2171},{"_1097":1653,"_1099":2264},"Source image",{"_1097":2175,"_1099":2266},"Amount of RAM to be allocated to the instance; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib",{"_1097":1088,"_1099":2268},"Name of the instance to create",{"_1097":2179,"_1099":2270},"Number of vCPUs to be allocated to the instance",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2273},"Project for image and instance",{"_1097":1625,"_1099":2275},"Boot disk size; unit suffixes are in powers of two (1k = 1024 bytes) for example: 6GiB, 512k, 2048mib",{"_1097":1685,"_1099":2277},"Start the instance immediately",{"_1088":1134,"_1092":2279,"_1094":2280},"

List instances

\n",[2281,2282,2283,2284],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":2285},[1164,1165,1166],{"_1088":2287,"_1094":2288,"_1121":2290},"nic",[2289],{"_1097":1111,"_1099":1112,"_1113":1114},[2291,2310,2319,2328,2343],{"_1088":1246,"_1092":2292,"_1094":2293},"

Create network interface

\n",[2294,2295,2296,2298,2299,2300,2301,2302,2304,2307],{"_1097":21},{"_1097":1735,"_1099":2193},{"_1097":1953,"_1099":2297},"The IP address for the interface. One will be auto-assigned if not provided.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2303},"Name or ID of the project, only required if `instance` is provided as a `Name`",{"_1097":2305,"_1099":2306},"subnet-name","The VPC Subnet in which to create the interface.",{"_1097":2308,"_1099":2309},"vpc-name","The VPC in which to create the interface.",{"_1088":36,"_1092":2311,"_1170":341,"_1094":2312},"

Delete network interface

\n",[2313,2314,2317,2318],{"_1097":1735,"_1099":2193},{"_1097":2315,"_1099":2316},"interface","Name or ID of the network interface",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2303},{"_1088":1134,"_1092":2320,"_1094":2321},"

List network interfaces

\n",[2322,2323,2324,2325,2326],{"_1097":1735,"_1099":2193},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2303},{"_1097":1161,"_1162":2327},[1164,1165,1166],{"_1088":1285,"_1092":2329,"_1094":2330},"

Update network interface

\n",[2331,2332,2333,2334,2335,2336,2337,2341,2342],{"_1097":21},{"_1097":1735,"_1099":2193},{"_1097":2315,"_1099":2316},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":2338,"_1162":2339,"_1099":2340},"primary",[1175,1176],"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.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2303},{"_1088":1235,"_1092":2344,"_1094":2345},"

Fetch network interface

\n",[2346,2347,2348,2349],{"_1097":1735,"_1099":2193},{"_1097":2315,"_1099":2316},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2303},{"_1088":2351,"_1094":2352,"_1121":2354},"property",[2353],{"_1097":1111,"_1099":1112,"_1113":1114},[2355,2364,2373],{"_1088":1740,"_1092":2356,"_1094":2357},"

List affinity groups containing instance

\n",[2358,2359,2360,2361,2362],{"_1097":1735,"_1099":2193},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":2363},[1164,1165,1166],{"_1088":2070,"_1092":2365,"_1094":2366},"

List anti-affinity groups containing instance

\n",[2367,2368,2369,2370,2371],{"_1097":1735,"_1099":2193},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":2372},[1164,1165,1166],{"_1088":1571,"_1092":2374,"_1170":315,"_1094":2375},"

List SSH public keys for instance

\n",[2376,2377,2378,2379,2380],{"_1097":1735,"_1099":2193},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":2381},[1164,1165,1166],{"_1088":2383,"_1092":2384,"_1094":2385},"reboot","

Reboot an instance

\n",[2386,2387,2388],{"_1097":1735,"_1099":2193},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":2390,"_1092":2391,"_1094":2392,"_1121":2394},"serial","

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

\n",[2393],{"_1097":1111,"_1099":1112,"_1113":1114},[2395,2418],{"_1088":2396,"_1092":2397,"_1170":2398,"_1094":2399},"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",[2400,2403,2407,2408,2412,2413,2414],{"_1097":2401,"_1099":2402},"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",{"_1097":2404,"_1302":2405,"_1099":2406},"escape-string","e","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.",{"_1097":1735,"_1302":1311,"_1099":2193},{"_1097":2409,"_1302":2410,"_1099":2411},"most-recent","m","The number of bytes from the most recent output to retrieve as context before connecting to the interactive session directly",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1302":1457,"_1099":1623},{"_1097":2415,"_1302":2416,"_1099":2417},"tty","t","Use a specified tty device (e.g. /dev/ttyUSB0) rather than the current terminal's stdin/stdout",{"_1088":2419,"_1092":2420,"_1170":2421,"_1094":2422},"history","

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",[2423,2427,2428,2432,2435,2436],{"_1097":2424,"_1302":2425,"_1099":2426},"byte-offset","b","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",{"_1097":1735,"_1302":1311,"_1099":2193},{"_1097":2429,"_1302":2430,"_1099":2431},"json","j","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",{"_1097":2433,"_1302":2410,"_1099":2434},"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)",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1302":1457,"_1099":1623},{"_1088":1685,"_1092":2438,"_1094":2439},"

Boot instance

\n",[2440,2441,2442],{"_1097":1735,"_1099":2193},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1692,"_1092":2444,"_1094":2445},"

Stop instance

\n",[2446,2447,2448],{"_1097":1735,"_1099":2193},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1285,"_1092":2450,"_1094":2451},"

Update instance

\n",[2452,2455,2458,2460,2461,2462,2463,2464,2465,2466],{"_1097":2157,"_1162":2453,"_1099":2454},[2159,2160],"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`.",{"_1097":2456,"_1099":2457},"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.",{"_1097":2163,"_1162":2459,"_1099":2167},[2165,2166],{"_1097":1735,"_1099":2193},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2175,"_1099":2176},{"_1097":2179,"_1099":2180},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1235,"_1092":2468,"_1094":2469},"

Fetch instance

\n",[2470,2471,2472],{"_1097":1735,"_1099":2193},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":2474,"_1094":2475,"_1121":2477},"internet-gateway",[2476],{"_1097":1111,"_1099":1112,"_1113":1114},[2478,2523,2534,2545,2582,2591],{"_1088":2479,"_1094":2480,"_1121":2482},"address",[2481],{"_1097":1111,"_1099":1112,"_1113":1114},[2483,2500,2513],{"_1088":1246,"_1092":2484,"_1094":2485},"

Attach IP address to internet gateway

\n",[2486,2487,2488,2491,2492,2493,2494,2495,2497],{"_1097":2479},{"_1097":21},{"_1097":2489,"_1099":2490},"gateway","Name or ID of the internet gateway",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},"Name or ID of the project, only required if `vpc` is provided as a `Name`",{"_1097":2498,"_1099":2499},"vpc","Name or ID of the VPC, only required if `gateway` is provided as a `Name`",{"_1088":36,"_1092":2501,"_1094":2502},"

Detach IP address from internet gateway

\n",[2503,2505,2509,2510,2511,2512],{"_1097":2479,"_1099":2504},"Name or ID of the IP address",{"_1097":2506,"_1162":2507,"_1099":2508},"cascade",[1175,1176],"Also delete routes targeting this gateway element.",{"_1097":2489,"_1099":2490},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2499},{"_1088":1134,"_1092":2514,"_1094":2515},"

List IP addresses attached to internet gateway

\n",[2516,2517,2518,2519,2520,2522],{"_1097":2489,"_1099":2490},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":1161,"_1162":2521},[1164,1165,1166],{"_1097":2498,"_1099":2499},{"_1088":1246,"_1092":2524,"_1094":2525},"

Create VPC internet gateway

\n",[2526,2527,2528,2529,2530,2531,2532],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2533},"Name or ID of the VPC",{"_1088":36,"_1092":2535,"_1094":2536},"

Delete internet gateway

\n",[2537,2540,2542,2543,2544],{"_1097":2506,"_1162":2538,"_1099":2539},[1175,1176],"Also delete routes targeting this gateway.",{"_1097":2489,"_1099":2541},"Name or ID of the gateway",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2533},{"_1088":1846,"_1094":2546,"_1121":2548},[2547],{"_1097":1111,"_1099":1112,"_1113":1114},[2549,2561,2572],{"_1088":1932,"_1092":2550,"_1094":2551},"

Attach IP pool to internet gateway

\n",[2552,2553,2554,2555,2556,2557,2558,2559,2560],{"_1097":21},{"_1097":2489,"_1099":2490},{"_1097":1846},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2499},{"_1088":1970,"_1092":2562,"_1094":2563},"

Detach IP pool from internet gateway

\n",[2564,2566,2567,2569,2570,2571],{"_1097":2506,"_1162":2565,"_1099":2508},[1175,1176],{"_1097":2489,"_1099":2490},{"_1097":1959,"_1099":2568},"Name or ID of the IP pool",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2499},{"_1088":1134,"_1092":2573,"_1094":2574},"

List IP pools attached to internet gateway

\n",[2575,2576,2577,2578,2579,2581],{"_1097":2489,"_1099":2490},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":1161,"_1162":2580},[1164,1165,1166],{"_1097":2498,"_1099":2499},{"_1088":1134,"_1092":2583,"_1094":2584},"

List internet gateways

\n",[2585,2586,2587,2588,2590],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":1161,"_1162":2589},[1164,1165,1166],{"_1097":2498,"_1099":2533},{"_1088":1235,"_1092":2592,"_1094":2593},"

Fetch internet gateway

\n",[2594,2595,2596,2597],{"_1097":2489,"_1099":2541},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2533},{"_1088":1846,"_1094":2599,"_1121":2601},[2600],{"_1097":1111,"_1099":1112,"_1113":1114},[2602,2616,2621,2628,2660,2693,2737,2746,2752],{"_1088":1246,"_1092":2603,"_1094":2604},"

Create IP pool

\n",[2605,2606,2612,2613,2614,2615],{"_1097":21},{"_1097":2607,"_1162":2608,"_1099":2611},"ip-version",[2609,2610],"v4","v6","The IP version of the pool.\n\nThe default is IPv4.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":36,"_1092":2617,"_1094":2618},"

Delete IP pool

\n",[2619,2620],{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":2622,"_1094":2623},"

List IP pools

\n",[2624,2625,2626],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":2627},[1164,1165,1166],{"_1088":2629,"_1094":2630,"_1121":2632},"range",[2631],{"_1097":1111,"_1099":1112,"_1113":1114},[2633,2644,2650],{"_1088":1263,"_1092":2634,"_1170":626,"_1094":2635},"

Add range to IP pool

\n",[2636,2638,2639,2640,2642,2643],{"_1097":2637},"first",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2641},"last",{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":2645,"_1170":621,"_1094":2646},"

List ranges for IP pool

\n",[2647,2648,2649],{"_1097":1141,"_1099":1142},{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":2651,"_1092":2652,"_1094":2653},"remove","

Remove range from IP pool

\n",[2654,2655,2656,2657,2658,2659],{"_1097":2637},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2641},{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1500,"_1094":2661,"_1121":2663},[2662],{"_1097":1111,"_1099":1112,"_1113":1114},[2664,2681,2689],{"_1088":2629,"_1094":2665,"_1121":2667},[2666],{"_1097":1111,"_1099":1112,"_1113":1114},[2668,2676],{"_1088":1263,"_1092":2669,"_1170":626,"_1094":2670},"

Add IP range to Oxide service pool

\n",[2671,2672,2673,2674,2675],{"_1097":2637},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2641},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":2677,"_1170":621,"_1094":2678},"

List IP ranges for the Oxide service pool

\n",[2679,2680],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":2651,"_1092":2682,"_1094":2683},"

Remove IP range from Oxide service pool

\n",[2684,2685,2686,2687,2688],{"_1097":2637},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2641},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":2690,"_1094":2691},"

Fetch Oxide service IP pool

\n",[2692],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":2694,"_1094":2695,"_1121":2697},"silo",[2696],{"_1097":1111,"_1099":1112,"_1113":1114},[2698,2711,2719,2726],{"_1088":2699,"_1092":2700,"_1170":638,"_1094":2701},"link","

Link IP pool to silo

\n",[2702,2706,2707,2708,2709,2710],{"_1097":2703,"_1162":2704,"_1099":2705},"is-default",[1175,1176],"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. There can be at most one default for a given silo.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694},{"_1088":1134,"_1092":2712,"_1094":2713},"

List IP pool's linked silos

\n",[2714,2715,2716,2717],{"_1097":1141,"_1099":1142},{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":2718},[1166],{"_1088":2720,"_1092":2721,"_1170":647,"_1094":2722},"unlink","

Unlink IP pool from silo

\n",[2723,2724,2725],{"_1097":1959},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694},{"_1088":1285,"_1092":2727,"_1170":643,"_1094":2728},"

Make IP pool default for silo

\n",[2729,2732,2733,2734,2735,2736],{"_1097":2703,"_1162":2730,"_1099":2731},[1175,1176],"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. There can be at most one default for a given silo, so when a pool is made default, an existing default will remain linked but will no longer be the default.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1959},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694},{"_1088":1285,"_1092":2738,"_1094":2739},"

Update IP pool

\n",[2740,2741,2742,2743,2744,2745],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":2747,"_1092":2748,"_1094":2749},"utilization","

Fetch IP pool utilization

\n",[2750,2751],{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":2753,"_1094":2754},"

Fetch IP pool

\n",[2755,2756],{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":914,"_1092":2758,"_1170":918,"_1094":2759},"

Ping API

\n",[2760],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1756,"_1094":2762,"_1121":2764},[2763],{"_1097":1111,"_1099":1112,"_1113":1114},[2765,2771],{"_1088":1285,"_1092":2766,"_1094":2767},"

Update current silo's IAM policy

\n",[2768,2769,2770],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":2772,"_1094":2773},"

Fetch current silo's IAM policy

\n",[2774],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1622,"_1094":2776,"_1121":2778},[2777],{"_1097":1111,"_1099":1112,"_1113":1114},[2779,2787,2792,2806,2813,2829,2838],{"_1088":1246,"_1092":2780,"_1094":2781},"

Create project

\n",[2782,2783,2784,2785,2786],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":36,"_1092":2788,"_1094":2789},"

Delete project

\n",[2790,2791],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1846,"_1094":2793,"_1121":2795},[2794],{"_1097":1111,"_1099":1112,"_1113":1114},[2796,2802],{"_1088":1134,"_1092":2622,"_1094":2797},[2798,2799,2800],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":2801},[1164,1165,1166],{"_1088":1235,"_1092":2753,"_1094":2803},[2804,2805],{"_1097":1959,"_1099":2568},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":2807,"_1094":2808},"

List projects

\n",[2809,2810,2811],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":2812},[1164,1165,1166],{"_1088":1756,"_1094":2814,"_1121":2816},[2815],{"_1097":1111,"_1099":1112,"_1113":1114},[2817,2824],{"_1088":1285,"_1092":2818,"_1094":2819},"

Update project's IAM policy

\n",[2820,2821,2822,2823],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1235,"_1092":2825,"_1094":2826},"

Fetch project's IAM policy

\n",[2827,2828],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1285,"_1092":2830,"_1094":2831},"

Update a project

\n",[2832,2833,2834,2835,2836,2837],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":1235,"_1092":2839,"_1094":2840},"

Fetch project

\n",[2841,2842],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":2844,"_1094":2845,"_1121":2847},"scim",[2846],{"_1097":1111,"_1099":1112,"_1113":1114},[2848],{"_1088":2849,"_1094":2850,"_1121":2852},"token",[2851],{"_1097":1111,"_1099":1112,"_1113":1114},[2853,2859,2865,2870],{"_1088":1246,"_1092":2854,"_1170":838,"_1094":2855},"

Create SCIM token

\n",[2856,2857],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},"Name or ID of the silo",{"_1088":36,"_1092":2860,"_1170":834,"_1094":2861},"

Delete SCIM token

\n",[2862,2863,2864],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":1553},{"_1088":1134,"_1092":2866,"_1170":834,"_1094":2867},"

List SCIM tokens

\n",[2868,2869],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1088":1235,"_1092":2871,"_1170":834,"_1094":2872},"

Fetch SCIM token

\n",[2873,2874,2875],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":1553},{"_1088":2694,"_1094":2877,"_1121":2879},[2878],{"_1097":1111,"_1099":1112,"_1113":1114},[2880,2900,2905,3007,3019,3026,3042,3074,3092,3108],{"_1088":1246,"_1092":2881,"_1094":2882},"

Create a silo

\n",[2883,2886,2887,2890,2896,2897,2898,2899],{"_1097":2884,"_1099":2885},"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.",{"_1097":21},{"_1097":2888,"_1162":2889},"discoverable",[1175,1176],{"_1097":2891,"_1162":2892},"identity-mode",[2893,2894,2895],"saml_jit","local_only","saml_scim",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":36,"_1092":2901,"_1170":869,"_1094":2902},"

Delete a silo

\n",[2903,2904],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1088":2906,"_1094":2907,"_1121":2909},"idp",[2908],{"_1097":1111,"_1099":1112,"_1113":1114},[2910,2918,2955],{"_1088":1134,"_1092":2911,"_1170":807,"_1094":2912},"

List identity providers for silo

\n",[2913,2914,2915,2916],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":1161,"_1162":2917},[1164,1165,1166],{"_1088":2919,"_1094":2920,"_1121":2922},"local",[2921],{"_1097":1111,"_1099":1112,"_1113":1114},[2923],{"_1088":2924,"_1094":2925,"_1121":2927},"user",[2926],{"_1097":1111,"_1099":1112,"_1113":1114},[2928,2938,2946],{"_1088":1246,"_1092":2929,"_1170":812,"_1094":2930},"

Create user

\n",[2931,2934,2935,2936,2937],{"_1097":2932,"_1099":2933},"external-id","username used to log in",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1088":36,"_1092":2939,"_1094":2940},"

Delete user

\n",[2941,2942,2943],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":2944,"_1099":2945},"user-id","The user's internal ID",{"_1088":2947,"_1092":2948,"_1170":821,"_1094":2949},"set-password","

Set or invalidate user's password

\n",[2950,2951,2952,2953,2954],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":2944,"_1099":2945},{"_1088":2956,"_1094":2957,"_1121":2959},"saml",[2958],{"_1097":1111,"_1099":1112,"_1113":1114},[2960,2999],{"_1088":1246,"_1092":2961,"_1094":2962},"

Create SAML identity provider

\n",[2963,2966,2967,2970,2973,2974,2975,2978,2981,2982,2985,2986,2989,2990,2993,2996],{"_1097":2964,"_1099":2965},"acs-url","service provider endpoint where the response will be sent",{"_1097":21},{"_1097":2968,"_1099":2969},"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.",{"_1097":2971,"_1099":2972},"idp-entity-id","idp's entity id",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2976,"_1099":2977},"metadata-url","the URL of an identity provider metadata descriptor",{"_1097":2979,"_1099":2980},"metadata-value","path to an XML file containing an identity provider metadata descriptor",{"_1097":1088},{"_1097":2983,"_1099":2984},"private-key","path to the request signing RSA private key in PKCS#1 DER format",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2987,"_1099":2988},"public-cert","path to the request signing public certificate in DER format",{"_1097":2694,"_1099":2858},{"_1097":2991,"_1099":2992},"slo-url","service provider endpoint where the idp should send log out requests",{"_1097":2994,"_1099":2995},"sp-client-id","sp's client id",{"_1097":2997,"_1099":2998},"technical-contact-email","customer's technical contact for saml configuration",{"_1088":1235,"_1092":3000,"_1094":3001},"

Fetch SAML identity provider

\n",[3002,3003,3006],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3004,"_1099":3005},"provider","Name or ID of the SAML identity provider",{"_1097":2694,"_1099":2858},{"_1088":1846,"_1094":3008,"_1121":3010},[3009],{"_1097":1111,"_1099":1112,"_1113":1114},[3011],{"_1088":1134,"_1092":3012,"_1170":874,"_1094":3013},"

List IP pools linked to silo

\n",[3014,3015,3016,3017],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":1161,"_1162":3018},[1164,1165,1166],{"_1088":1134,"_1092":3020,"_1170":857,"_1094":3021},"

List silos

\n",[3022,3023,3024],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3025},[1164,1165,1166],{"_1088":1756,"_1094":3027,"_1121":3029},[3028],{"_1097":1111,"_1099":1112,"_1113":1114},[3030,3037],{"_1088":1285,"_1092":3031,"_1094":3032},"

Update silo IAM policy

\n",[3033,3034,3035,3036],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1088":1235,"_1092":3038,"_1094":3039},"

Fetch silo IAM policy

\n",[3040,3041],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1088":3043,"_1094":3044,"_1121":3046},"quotas",[3045],{"_1097":1111,"_1099":1112,"_1113":1114},[3047,3054,3069],{"_1088":1134,"_1092":3048,"_1094":3049},"

Lists resource quotas for all silos

\n",[3050,3051,3052],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3053},[1166],{"_1088":1285,"_1092":3055,"_1170":889,"_1094":3056},"

Update resource quotas for silo

\n",[3057,3060,3061,3062,3064,3065,3066],{"_1097":3058,"_1099":3059},"cpus","The amount of virtual CPUs available for running instances in the Silo",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2175,"_1099":3063},"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",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":3067,"_1099":3068},"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",{"_1088":1235,"_1092":3070,"_1094":3071},"

Fetch resource quotas for silo

\n",[3072,3073],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1088":2924,"_1094":3075,"_1121":3077},[3076],{"_1097":1111,"_1099":1112,"_1113":1114},[3078,3086],{"_1088":1134,"_1092":3079,"_1094":3080},"

List built-in (system) users in silo

\n",[3081,3082,3083,3084],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":1161,"_1162":3085},[1166],{"_1088":1235,"_1092":3087,"_1094":3088},"

Fetch built-in (system) user

\n",[3089,3090,3091],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1097":2944,"_1099":2945},{"_1088":2747,"_1094":3093,"_1121":3095},[3094],{"_1097":1111,"_1099":1112,"_1113":1114},[3096,3103],{"_1088":1134,"_1092":3097,"_1094":3098},"

List current utilization state for all silos

\n",[3099,3100,3101],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3102},[1164,1165,1166],{"_1088":1235,"_1092":3104,"_1094":3105},"

Fetch current utilization for given silo

\n",[3106,3107],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1088":1235,"_1092":3109,"_1170":865,"_1094":3110},"

Fetch silo

\n",[3111,3112],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2694,"_1099":2858},{"_1088":1669,"_1094":3114,"_1121":3116},[3115],{"_1097":1111,"_1099":1112,"_1113":1114},[3117,3128,3135,3143],{"_1088":1246,"_1092":3118,"_1170":466,"_1094":3119},"

Create snapshot

\n",[3120,3121,3123,3124,3125,3126,3127],{"_1097":21},{"_1097":1609,"_1099":3122},"The disk to be snapshotted",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":36,"_1092":3129,"_1094":3130},"

Delete snapshot

\n",[3131,3132,3133],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1669,"_1099":3134},"Name or ID of the snapshot",{"_1088":1134,"_1092":3136,"_1094":3137},"

List snapshots

\n",[3138,3139,3140,3141],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":3142},[1164,1165,1166],{"_1088":1235,"_1092":3144,"_1094":3145},"

Fetch snapshot

\n",[3146,3147,3148],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1669,"_1099":3134},{"_1088":1833,"_1094":3150,"_1121":3152},[3151],{"_1097":1111,"_1099":1112,"_1113":1114},[3153,3332,4060,4074],{"_1088":3154,"_1094":3155,"_1121":3157},"hardware",[3156],{"_1097":1111,"_1099":1112,"_1113":1114},[3158,3176,3195,3260,3279],{"_1088":1609,"_1094":3159,"_1121":3161},[3160],{"_1097":1111,"_1099":1112,"_1113":1114},[3162,3169],{"_1088":1134,"_1092":3163,"_1094":3164},"

List physical disks

\n",[3165,3166,3167],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3168},[1166],{"_1088":1235,"_1092":3170,"_1094":3171},"

Get a physical disk

\n",[3172,3175],{"_1097":3173,"_1099":3174},"disk-id","ID of the physical disk",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3177,"_1094":3178,"_1121":3180},"rack",[3179],{"_1097":1111,"_1099":1112,"_1113":1114},[3181,3188],{"_1088":1134,"_1092":3182,"_1094":3183},"

List racks

\n",[3184,3185,3186],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3187},[1166],{"_1088":1235,"_1092":3189,"_1094":3190},"

Fetch rack

\n",[3191,3192],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3194},"rack-id","ID of the rack",{"_1088":1751,"_1094":3196,"_1121":3198},[3197],{"_1097":1111,"_1099":1112,"_1113":1114},[3199,3208,3219,3228,3235,3241,3255],{"_1088":1263,"_1092":3200,"_1094":3201},"

Add sled to initialized rack

\n",[3202,3203,3204,3206,3207],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":3205},"part",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2390},{"_1088":3209,"_1092":3210,"_1094":3211},"disk-led","

List physical disks attached to sleds

\n",[3212,3213,3214,3217],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3215,"_1099":3216},"sled-id","ID of the sled",{"_1097":1161,"_1162":3218},[1166],{"_1088":3220,"_1092":3221,"_1094":3222},"instance-list","

List instances running on given sled

\n",[3223,3224,3225,3226],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3215,"_1099":3216},{"_1097":1161,"_1162":3227},[1166],{"_1088":1134,"_1092":3229,"_1094":3230},"

List sleds

\n",[3231,3232,3233],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3234},[1166],{"_1088":3236,"_1092":3237,"_1094":3238},"list-uninitialized","

List uninitialized sleds

\n",[3239,3240],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3242,"_1092":3243,"_1094":3244},"set-provision-policy","

Set sled provision policy

\n",[3245,3246,3247,3248,3249],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3215,"_1099":3216},{"_1097":3250,"_1162":3251,"_1099":3254},"state",[3252,3253],"provisionable","non_provisionable","The provision state.",{"_1088":1235,"_1092":3256,"_1094":3257},"

Fetch sled

\n",[3258,3259],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3215,"_1099":3216},{"_1088":3261,"_1094":3262,"_1121":3264},"switch",[3263],{"_1097":1111,"_1099":1112,"_1113":1114},[3265,3272],{"_1088":1134,"_1092":3266,"_1094":3267},"

List switches

\n",[3268,3269,3270],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3271},[1166],{"_1088":1235,"_1092":3273,"_1094":3274},"

Fetch switch

\n",[3275,3276],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3277,"_1099":3278},"switch-id","ID of the switch",{"_1088":3280,"_1094":3281,"_1121":3283},"switch-port",[3282],{"_1097":1111,"_1099":1112,"_1113":1114},[3284,3302,3310,3320,3325],{"_1088":3285,"_1092":3286,"_1094":3287},"apply-settings","

Apply switch port settings

\n",[3288,3289,3290,3293,3296,3297,3299],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":3291,"_1099":3292},"port","A name to use when selecting switch ports.",{"_1097":3294,"_1099":3295},"port-settings","A name or id to use when applying switch port settings.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3298},"A rack id to use when selecting switch ports.",{"_1097":3300,"_1099":3301},"switch-location","A switch location to use when selecting switch ports.",{"_1088":3303,"_1092":3304,"_1094":3305},"clear-settings","

Clear switch port settings

\n",[3306,3307,3308,3309],{"_1097":3291,"_1099":3292},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3298},{"_1097":3300,"_1099":3301},{"_1088":1134,"_1092":3311,"_1094":3312},"

List switch ports

\n",[3313,3314,3315,3317],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3316},[1166],{"_1097":3318,"_1099":3319},"switch-port-id","An optional switch port id to use when listing switch ports.",{"_1088":3321,"_1092":3322,"_1094":3323},"show-status","

Get the status of switch ports.

\n",[3324],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1389,"_1092":3326,"_1094":3327},"

Get switch port status

\n",[3328,3329,3330,3331],{"_1097":3291,"_1099":3292},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3298},{"_1097":3300,"_1099":3301},{"_1088":3333,"_1094":3334,"_1121":3336},"networking",[3335],{"_1097":1111,"_1099":1112,"_1113":1114},[3337,3411,3459,3477,3522,3803,3822,3878,3933,3978,4022],{"_1088":3338,"_1092":3339,"_1094":3340,"_1121":3342},"addr","

Manage switch port addresses.

\n",[3341],{"_1097":1111,"_1099":1112,"_1113":1114},[3343,3397],{"_1088":1263,"_1092":3344,"_1094":3345},"

Add an address to a port configuration

\n",[3346,3348,3351,3386,3387,3389,3394],{"_1097":3338,"_1099":3347},"Address to add",{"_1097":3349,"_1099":3350},"lot","Address lot to allocate from",{"_1097":3291,"_1162":3352,"_1099":3385},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"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","Port to add the address to",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3388},"Id of the rack to add the address to",{"_1097":3261,"_1162":3390,"_1099":3393},[3391,3392],"switch0","switch1","Switch to add the address to",{"_1097":3395,"_1099":3396},"vlan","Optional VLAN to assign to the address",{"_1088":36,"_1092":3398,"_1094":3399},"

Remove an address from a port configuration

\n",[3400,3402,3405,3406,3408],{"_1097":3338,"_1099":3401},"Address to remove",{"_1097":3291,"_1162":3403,"_1099":3404},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to remove the address from",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3407},"Id of the rack to remove the address from",{"_1097":3261,"_1162":3409,"_1099":3410},[3391,3392],"Switch to remove the address from",{"_1088":3412,"_1094":3413,"_1121":3415},"address-lot",[3414],{"_1097":1111,"_1099":1112,"_1113":1114},[3416,3430,3442,3447,3454],{"_1088":3417,"_1094":3418,"_1121":3420},"block",[3419],{"_1097":1111,"_1099":1112,"_1113":1114},[3421],{"_1088":1134,"_1092":3422,"_1094":3423},"

List blocks in address lot

\n",[3424,3426,3427,3428],{"_1097":3412,"_1099":3425},"Name or ID of the address lot",{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3429},[1166],{"_1088":1246,"_1092":3431,"_1094":3432},"

Create address lot

\n",[3433,3434,3435,3436,3440,3441],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1940,"_1162":3437,"_1099":3439},[3438,1959],"infra","The kind of address lot to create.",{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":36,"_1092":3443,"_1094":3444},"

Delete address lot

\n",[3445,3446],{"_1097":3412,"_1099":3425},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":3448,"_1094":3449},"

List address lots

\n",[3450,3451,3452],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3453},[1164,1165,1166],{"_1088":1235,"_1092":3455,"_1094":3456},"

Fetch address lot

\n",[3457,3458],{"_1097":3412,"_1099":3425},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3460,"_1094":3461,"_1121":3463},"allow-list",[3462],{"_1097":1111,"_1099":1112,"_1113":1114},[3464,3473],{"_1088":1285,"_1092":3465,"_1094":3466},"

Update user-facing services IP allowlist

\n",[3467,3469,3470,3471,3472],{"_1097":3468},"any",{"_1097":1953},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":3474,"_1094":3475},"

Get user-facing services IP allowlist

\n",[3476],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3478,"_1094":3479,"_1121":3481},"bfd",[3480],{"_1097":1111,"_1099":1112,"_1113":1114},[3482,3494,3518],{"_1088":3483,"_1092":3484,"_1094":3485},"disable","

Disable a BFD session

\n",[3486,3487,3488,3489,3492],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3490,"_1099":3491},"remote","Address of the remote peer to disable a BFD session for.",{"_1097":3261,"_1099":3493},"The switch to enable this session on. Must be `switch0` or `switch1`.",{"_1088":3495,"_1092":3496,"_1094":3497},"enable","

Enable a BFD session

\n",[3498,3501,3502,3503,3505,3511,3512,3514,3517],{"_1097":3499,"_1099":3500},"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)",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":2919,"_1099":3504},"Address the Oxide switch will listen on for BFD traffic. If `None` then the unspecified address (0.0.0.0 or ::) is used.",{"_1097":3506,"_1162":3507,"_1099":3510},"mode",[3508,3509],"single_hop","multi_hop","Select either single-hop (RFC 5881) or multi-hop (RFC 5883)",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3490,"_1099":3513},"Address of the remote peer to establish a BFD session with.",{"_1097":3515,"_1099":3516},"required-rx","The minimum interval, in microseconds, between received BFD Control packets that this system requires",{"_1097":3261,"_1099":3493},{"_1088":1389,"_1092":3519,"_1094":3520},"

Get BFD status

\n",[3521],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3523,"_1094":3524,"_1121":3526},"bgp",[3525],{"_1097":1111,"_1099":1112,"_1113":1114},[3527,3542,3570,3580,3599,3634,3644,3670,3676,3686,3767,3784,3789,3793],{"_1088":3528,"_1092":3529,"_1170":3530,"_1094":3531},"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",[3532,3534,3537,3538,3541],{"_1097":3412,"_1099":3533},"The address lot to draw from",{"_1097":3535,"_1099":3536},"announce-set","The announce set to announce from",{"_1097":21},{"_1097":3539,"_1099":3540},"prefix","The prefix to announce",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3535,"_1094":3543,"_1121":3545},[3544],{"_1097":1111,"_1099":1112,"_1113":1114},[3546,3552,3562],{"_1088":36,"_1092":3547,"_1094":3548},"

Delete BGP announce set

\n",[3549,3551],{"_1097":3535,"_1099":3550},"Name or ID of the announce set",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":3553,"_1094":3554},"

List BGP announce sets

\n",[3555,3556,3559,3560],{"_1097":1141,"_1099":1142},{"_1097":3557,"_1099":3558},"page-token","Token returned by previous call to retrieve the subsequent page",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3561},[1164,1165,1166],{"_1088":1285,"_1092":3563,"_1170":746,"_1094":3564},"

Update BGP announce set

\n",[3565,3566,3567,3568,3569],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3571,"_1094":3572,"_1121":3574},"announcement",[3573],{"_1097":1111,"_1099":1112,"_1113":1114},[3575],{"_1088":1134,"_1092":3576,"_1094":3577},"

Get originated routes for a specified BGP announce set

\n",[3578,3579],{"_1097":3535,"_1099":3550},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1351,"_1092":3581,"_1170":3582,"_1094":3583},"

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",[3584,3587,3590,3593,3594,3596],{"_1097":3585,"_1099":3586},"authstring","Use the given authorization string for TCP-MD5 authentication with the peer",{"_1097":3588,"_1099":3589},"peer","Peer to add the auth config to",{"_1097":3291,"_1162":3591,"_1099":3592},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to add the auth config to",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3595},"Id of the rack to add the auth config to",{"_1097":3261,"_1162":3597,"_1099":3598},[3391,3392],"Switch to add the auth config to",{"_1088":3600,"_1094":3601,"_1121":3603},"config",[3602],{"_1097":1111,"_1099":1112,"_1113":1114},[3604,3620,3627],{"_1088":1246,"_1092":3605,"_1094":3606},"

Create new BGP configuration

\n",[3607,3610,3612,3613,3614,3615,3616,3617],{"_1097":3608,"_1099":3609},"asn","The autonomous system number of this BGP configuration.",{"_1097":3611},"bgp-announce-set-id",{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3618,"_1099":3619},"vrf","Optional virtual routing and forwarding identifier for this BGP configuration.",{"_1088":36,"_1092":3621,"_1094":3622},"

Delete BGP configuration

\n",[3623,3626],{"_1097":3624,"_1099":3625},"name-or-id","A name or id to use when selecting BGP config.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":3628,"_1094":3629},"

List BGP configurations

\n",[3630,3631,3632],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3633},[1164,1165,1166],{"_1088":3635,"_1094":3636,"_1121":3638},"exported",[3637],{"_1097":1111,"_1099":1112,"_1113":1114},[3639],{"_1088":3640,"_1092":3641,"_1094":3642},"ipv4","

Get BGP exported routes

\n",[3643],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1138,"_1092":3645,"_1170":3646,"_1094":3647},"

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",[3648,3651,3656,3659,3661,3664,3665,3667],{"_1097":3649,"_1099":3650},"allowed","Prefixes to allow for the peer",{"_1097":3652,"_1162":3653,"_1099":3655},"direction",[1635,3654],"export","Whether to apply the filter to imported or exported prefixes",{"_1097":3657,"_1099":3658},"no-filtering","Do not filter",{"_1097":3588,"_1099":3660},"Peer to apply allow list to",{"_1097":3291,"_1162":3662,"_1099":3663},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to add the filter to",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3666},"Id of the rack to add the filter to",{"_1097":3261,"_1162":3668,"_1099":3669},[3391,3392],"Switch to add the filter to",{"_1088":2419,"_1092":3671,"_1094":3672},"

Get BGP router message history

\n",[3673,3675],{"_1097":3608,"_1099":3674},"The ASN to filter on. Required.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3677,"_1094":3678,"_1121":3680},"imported",[3679],{"_1097":1111,"_1099":1112,"_1113":1114},[3681],{"_1088":3640,"_1092":3682,"_1094":3683},"

Get imported IPv4 BGP routes

\n",[3684,3685],{"_1097":3608,"_1099":3674},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3588,"_1092":3687,"_1170":3688,"_1094":3689,"_1121":3691},"

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",[3690],{"_1097":1111,"_1099":1112,"_1113":1114},[3692,3706],{"_1088":36,"_1092":3693,"_1094":3694},"

Remove a BGP from a port configuration

\n",[3695,3697,3700,3701,3703],{"_1097":3338,"_1099":3696},"Address of the peer to remove",{"_1097":3291,"_1162":3698,"_1099":3699},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to remove the peer from",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3702},"Id of the rack to remove the peer from",{"_1097":3261,"_1162":3704,"_1099":3705},[3391,3392],"Switch to remove the peer from",{"_1088":3707,"_1092":3708,"_1094":3709},"set","

Set a BGP peer on a port configuration

\n",[3710,3712,3715,3718,3719,3722,3725,3728,3731,3734,3737,3740,3743,3746,3749,3752,3755,3756,3758,3761,3764],{"_1097":3338,"_1099":3711},"Address of the peer to set the config for",{"_1097":3713,"_1099":3714},"allowed-exports","Prefixes that may be exported to the peer. Empty list means all prefixes allowed",{"_1097":3716,"_1099":3717},"allowed-imports","Prefixes that may be imported from the peer. Empty list means all prefixes allowed",{"_1097":3585,"_1099":3586},{"_1097":3720,"_1099":3721},"bgp-config","BGP configuration this peer is associated with",{"_1097":3723,"_1099":3724},"communities","Include the provided communities in updates sent to the peer",{"_1097":3726,"_1099":3727},"connect-retry","How long to wait between TCP connection retries (seconds)",{"_1097":3729,"_1099":3730},"delay-open","How long to delay sending an open request after establishing a TCP session (seconds)",{"_1097":3732,"_1099":3733},"enforce-first-as","Enforce that the first AS in paths received from this peer is the peer's AS",{"_1097":3735,"_1099":3736},"hold-time","How long to hold peer connections between keepalives (seconds)",{"_1097":3738,"_1099":3739},"idle-hold-time","How long to hold a peer in idle before attempting a new session (seconds)",{"_1097":3741,"_1099":3742},"keepalive","How often to send keepalive requests (seconds)",{"_1097":3744,"_1099":3745},"local-pref","Apply this local preference to routes received from the peer",{"_1097":3747,"_1099":3748},"min-ttl","Require messages from a peer have a minimum IP time to live field",{"_1097":3750,"_1099":3751},"multi-exit-discriminator","Apply the provided multi-exit discriminator (MED) updates sent to the peer",{"_1097":3291,"_1162":3753,"_1099":3754},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to set the peer config on",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3757},"Id of the rack to set the peer config on",{"_1097":3759,"_1099":3760},"remote-asn","Require that a peer has a specified ASN",{"_1097":3261,"_1162":3762,"_1099":3763},[3391,3392],"Switch to set the peer config on",{"_1097":3765,"_1099":3766},"vlan-id","Associate a VLAN ID with a peer",{"_1088":3768,"_1092":3769,"_1170":3770,"_1094":3771},"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",[3772,3773,3775,3778,3779,3781],{"_1097":3744,"_1099":3745},{"_1097":3588,"_1099":3774},"Peer to set the route preference on",{"_1097":3291,"_1162":3776,"_1099":3777},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to set the route preference on",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3780},"Id of the rack to set the route preference on",{"_1097":3261,"_1162":3782,"_1099":3783},[3391,3392],"Switch to set the route preference on",{"_1088":3321,"_1092":3785,"_1170":3786,"_1094":3787},"

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",[3788],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1389,"_1092":3790,"_1094":3791},"

Get BGP peer status

\n",[3792],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3794,"_1092":3795,"_1170":3796,"_1094":3797},"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",[3798,3800,3802],{"_1097":3535,"_1099":3799},"The announce set to withdraw from",{"_1097":3539,"_1099":3801},"The prefix to withdraw",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":3804,"_1094":3805,"_1121":3807},"inbound-icmp",[3806],{"_1097":1111,"_1099":1112,"_1113":1114},[3808,3818],{"_1088":1285,"_1092":3809,"_1094":3810},"

Set whether API services can receive limited ICMP traffic

\n",[3811,3815,3816,3817],{"_1097":3812,"_1162":3813,"_1099":3814},"enabled",[1175,1176],"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.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":3819,"_1094":3820},"

Return whether API services can receive limited ICMP traffic

\n",[3821],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":2699,"_1092":3823,"_1170":3824,"_1094":3825,"_1121":3827},"

Manage switch port links.

\n","

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",[3826],{"_1097":1111,"_1099":1112,"_1113":1114},[3828,3866],{"_1088":1263,"_1092":3829,"_1094":3830},"

Add a link to a port

\n",[3831,3834,3841,3844,3847,3848,3850,3863],{"_1097":3832,"_1099":3833},"autoneg","Whether or not to set auto-negotiation",{"_1097":3835,"_1162":3836,"_1099":3840},"fec",[3837,3838,3839],"firecode","none","rs","The forward error correction mode of the link",{"_1097":3842,"_1099":3843},"mtu","Maximum transmission unit for the link",{"_1097":3291,"_1162":3845,"_1099":3846},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to add the link to",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3849},"Id of the rack to add the link to",{"_1097":3851,"_1162":3852,"_1099":3862},"speed",[3853,3854,3855,3856,3857,3858,3859,3860,3861],"0g","1g","10g","25g","40g","50g","100g","200g","400g","The speed of the link",{"_1097":3261,"_1162":3864,"_1099":3865},[3391,3392],"Switch to add the link to",{"_1088":36,"_1092":3867,"_1094":3868},"

Remove a link from a port

\n",[3869,3872,3873,3875],{"_1097":3291,"_1162":3870,"_1099":3871},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to remove the link from",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3874},"Id of the rack to remove the link from",{"_1097":3261,"_1162":3876,"_1099":3877},[3391,3392],"Switch to remove the link from",{"_1088":3879,"_1094":3880,"_1121":3882},"lldp",[3881],{"_1097":1111,"_1099":1112,"_1113":1114},[3883,3894,3926],{"_1088":3884,"_1092":3885,"_1094":3886},"neighbors","

Fetch the LLDP neighbors seen on a switch port

\n",[3887,3888,3889,3890,3891,3893],{"_1097":1141,"_1099":1142},{"_1097":3291,"_1099":3292},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3298},{"_1097":1161,"_1162":3892},[1166],{"_1097":3300,"_1099":3301},{"_1088":1285,"_1092":3895,"_1094":3896},"

Update the LLDP configuration for a switch port

\n",[3897,3900,3903,3905,3906,3907,3910,3913,3916,3917,3918,3919,3920,3923],{"_1097":3898,"_1099":3899},"chassis-id","The LLDP chassis identifier TLV.",{"_1097":3812,"_1162":3901,"_1099":3902},[1175,1176],"Whether or not the LLDP service is enabled.",{"_1097":1442,"_1099":3904},"The id of this LLDP service instance.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":3908,"_1099":3909},"link-description","The LLDP link description TLV.",{"_1097":3911,"_1099":3912},"link-name","The LLDP link name TLV.",{"_1097":3914,"_1099":3915},"management-ip","The LLDP management IP TLV.",{"_1097":3291,"_1099":3292},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3298},{"_1097":3300,"_1099":3301},{"_1097":3921,"_1099":3922},"system-description","The LLDP system description TLV.",{"_1097":3924,"_1099":3925},"system-name","The LLDP system name TLV.",{"_1088":1235,"_1092":3927,"_1094":3928},"

Fetch the LLDP configuration for a switch port

\n",[3929,3930,3931,3932],{"_1097":3291,"_1099":3292},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3298},{"_1097":3300,"_1099":3301},{"_1088":3934,"_1094":3935,"_1121":3937},"loopback-address",[3936],{"_1097":1111,"_1099":1112,"_1113":1114},[3938,3959,3971],{"_1088":1246,"_1092":3939,"_1094":3940},"

Create loopback address

\n",[3941,3943,3945,3949,3950,3951,3954,3955,3957],{"_1097":2479,"_1099":3942},"The address to create.",{"_1097":3412,"_1099":3944},"The name or id of the address lot this loopback address will pull an address from.",{"_1097":3946,"_1162":3947,"_1099":3948},"anycast",[1175,1176],"Address is an anycast address. This allows the address to be assigned to multiple locations simultaneously.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":3952,"_1099":3953},"mask","The subnet mask to use for the address.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3956},"The containing the switch this loopback address will be configured on.",{"_1097":3300,"_1099":3958},"The location of the switch within the rack this loopback address will be configured on.",{"_1088":36,"_1092":3960,"_1094":3961},"

Delete loopback address

\n",[3962,3964,3965,3967,3969],{"_1097":2479,"_1099":3963},"The IP address and subnet mask to use when selecting the loopback address.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3193,"_1099":3966},"The rack to use when selecting the loopback address.",{"_1097":3968,"_1099":3963},"subnet-mask",{"_1097":3300,"_1099":3970},"The switch location to use when selecting the loopback address.",{"_1088":1134,"_1092":3972,"_1094":3973},"

List loopback addresses

\n",[3974,3975,3976],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":3977},[1166],{"_1088":3979,"_1092":3980,"_1094":3981,"_1121":3983},"route","

Manage static switch routes.

\n",[3982],{"_1097":1111,"_1099":1112,"_1113":1114},[3984,4004],{"_1088":36,"_1092":3985,"_1094":3986},"

Delete a static route

\n",[3987,3990,3993,3996,3997,3999,4002],{"_1097":3988,"_1099":3989},"destination","The route destination",{"_1097":3991,"_1099":3992},"nexthop","The route nexthop",{"_1097":3291,"_1162":3994,"_1099":3995},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to remove the route from",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":3998},"Id of the rack to remove the route from",{"_1097":3261,"_1162":4000,"_1099":4001},[3391,3392],"Switch to remove the route from",{"_1097":3765,"_1099":4003},"The route vlan id",{"_1088":3707,"_1092":4005,"_1094":4006},"

Set a static route

\n",[4007,4008,4009,4012,4013,4015,4018,4021],{"_1097":3988,"_1099":3989},{"_1097":3991,"_1099":3992},{"_1097":3291,"_1162":4010,"_1099":4011},[3353,3354,3355,3356,3357,3358,3359,3360,3361,3362,3363,3364,3365,3366,3367,3368,3369,3370,3371,3372,3373,3374,3375,3376,3377,3378,3379,3380,3381,3382,3383,3384],"Port to configure the route on",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":3177,"_1099":4014},"Id of the rack to configure the route on",{"_1097":4016,"_1099":4017},"rib-priority","RIB Priority indicating priority within and across protocols",{"_1097":3261,"_1162":4019,"_1099":4020},[3391,3392],"Switch to configure the route on",{"_1097":3765,"_1099":4003},{"_1088":4023,"_1094":4024,"_1121":4026},"switch-port-settings",[4025],{"_1097":1111,"_1099":1112,"_1113":1114},[4027,4035,4041,4049,4054],{"_1088":1246,"_1092":4028,"_1094":4029},"

Create switch port settings

\n",[4030,4031,4032,4033,4034],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":36,"_1092":4036,"_1094":4037},"

Delete switch port settings

\n",[4038,4040],{"_1097":3294,"_1099":4039},"An optional name or id to use when selecting port settings.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1134,"_1092":4042,"_1094":4043},"

List switch port settings

\n",[4044,4045,4046,4047],{"_1097":1141,"_1099":1142},{"_1097":3294,"_1099":4039},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":4048},[1164,1165,1166],{"_1088":4050,"_1092":4051,"_1094":4052},"show","

Get the configuration of switch ports.

\n",[4053],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":4055,"_1094":4056},"

Get information about switch port

\n",[4057,4059],{"_1097":3291,"_1099":4058},"A name or id to use when selecting switch port settings info objects.",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1756,"_1094":4061,"_1121":4063},[4062],{"_1097":1111,"_1099":1112,"_1113":1114},[4064,4070],{"_1088":1285,"_1092":4065,"_1094":4066},"

Update top-level IAM policy

\n",[4067,4068,4069],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":4071,"_1094":4072},"

Fetch top-level IAM policy

\n",[4073],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1285,"_1094":4075,"_1121":4077},[4076],{"_1097":1111,"_1099":1112,"_1113":1114},[4078,4105,4109,4122],{"_1088":4079,"_1094":4080,"_1121":4082},"repo",[4081],{"_1097":1111,"_1099":1112,"_1113":1114},[4083,4092,4098],{"_1088":1134,"_1092":4084,"_1170":923,"_1094":4085},"

List all TUF repositories

\n",[4086,4087,4088],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":4089},[4090,4091],"version_ascending","version_descending",{"_1088":4093,"_1094":4094},"upload",[4095,4097],{"_1097":17,"_1302":1457,"_1099":4096},"Path to the TUF repository",{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1235,"_1092":4099,"_1094":4100},"

Fetch system release repository description by version

\n",[4101,4102],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":4103,"_1099":4104},"system-version","The version to get.",{"_1088":1389,"_1092":4106,"_1170":936,"_1094":4107},"

Fetch system update status

\n",[4108],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":4110,"_1094":4111,"_1121":4113},"target-release",[4112],{"_1097":1111,"_1099":1112,"_1113":1114},[4114],{"_1088":1285,"_1092":4115,"_1170":941,"_1094":4116},"

Set target release

\n",[4117,4118,4119,4120],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":4103,"_1099":4121},"Version of the system software to make the target release.",{"_1088":4123,"_1094":4124,"_1121":4126},"trust-root",[4125],{"_1097":1111,"_1099":1112,"_1113":1114},[4127,4133,4140,4147],{"_1088":1246,"_1092":4128,"_1094":4129},"

Add trusted root role to updates trust store

\n",[4130,4131,4132],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":36,"_1092":4134,"_1170":957,"_1094":4135},"

Delete trusted root role

\n",[4136,4137],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":4138,"_1099":4139},"trust-root-id","ID of the trust root",{"_1088":1134,"_1092":4141,"_1170":946,"_1094":4142},"

List root roles in the updates trust store

\n",[4143,4144,4145],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":4146},[1166],{"_1088":1235,"_1092":4148,"_1094":4149},"

Fetch trusted root role

\n",[4150,4151],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":4138,"_1099":4139},{"_1088":2924,"_1094":4153,"_1121":4155},[4154],{"_1097":1111,"_1099":1112,"_1113":1114},[4156,4164,4174,4183,4188],{"_1088":1134,"_1092":4157,"_1094":4158},"

List users

\n",[4159,4160,4161,4162],{"_1097":2001},{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":4163},[1166],{"_1088":4165,"_1092":4166,"_1094":4167},"list-sessions","

List user's console sessions

\n",[4168,4169,4170,4172],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":4171},[1166],{"_1097":2944,"_1099":4173},"ID of the user",{"_1088":4175,"_1092":4176,"_1094":4177},"list-tokens","

List user's access tokens

\n",[4178,4179,4180,4182],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1161,"_1162":4181},[1166],{"_1097":2944,"_1099":4173},{"_1088":1376,"_1092":4184,"_1170":450,"_1094":4185},"

Log user out

\n",[4186,4187],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2944,"_1099":4173},{"_1088":1235,"_1092":4189,"_1094":4190},"

Fetch user

\n",[4191,4192],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":2944,"_1099":4173},{"_1088":2747,"_1092":4194,"_1094":4195},"

Fetch resource utilization for user's current silo

\n",[4196],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":1090,"_1092":4198,"_1094":4199},"

Prints version information about the CLI.

\n",[4200],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1088":2498,"_1094":4202,"_1121":4204},[4203],{"_1097":1111,"_1099":1112,"_1113":1114},[4205,4219,4225,4244,4252,4357,4431,4442],{"_1088":1246,"_1092":4206,"_1094":4207},"

Create VPC

\n",[4208,4209,4211,4214,4215,4216,4217,4218],{"_1097":21},{"_1097":4210},"dns-name",{"_1097":4212,"_1099":4213},"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.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1088":36,"_1092":4220,"_1094":4221},"

Delete VPC

\n",[4222,4223,4224],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":2498,"_1099":2533},{"_1088":4226,"_1094":4227,"_1121":4229},"firewall-rules",[4228],{"_1097":1111,"_1099":1112,"_1113":1114},[4230,4238],{"_1088":1285,"_1092":4231,"_1170":1011,"_1094":4232},"

Replace firewall rules

\n",[4233,4234,4235,4236,4237],{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2533},{"_1088":1235,"_1092":4239,"_1094":4240},"

List firewall rules

\n",[4241,4242,4243],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2533},{"_1088":1134,"_1092":4245,"_1094":4246},"

List VPCs

\n",[4247,4248,4249,4250],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":1161,"_1162":4251},[1164,1165,1166],{"_1088":4253,"_1094":4254,"_1121":4256},"router",[4255],{"_1097":1111,"_1099":1112,"_1113":1114},[4257,4267,4275,4284,4339,4350],{"_1088":1246,"_1092":4258,"_1094":4259},"

Create VPC router

\n",[4260,4261,4262,4263,4264,4265,4266],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2533},{"_1088":36,"_1092":4268,"_1094":4269},"

Delete router

\n",[4270,4271,4272,4274],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":4253,"_1099":4273},"Name or ID of the router",{"_1097":2498,"_1099":2533},{"_1088":1134,"_1092":4276,"_1094":4277},"

List routers

\n",[4278,4279,4280,4281,4283],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":1161,"_1162":4282},[1164,1165,1166],{"_1097":2498,"_1099":2533},{"_1088":3979,"_1094":4285,"_1121":4287},[4286],{"_1097":1111,"_1099":1112,"_1113":1114},[4288,4300,4309,4319,4331],{"_1088":1246,"_1092":4289,"_1094":4290},"

Create route

\n",[4291,4292,4293,4294,4295,4296,4297,4298],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":4253,"_1099":4273},{"_1097":2498,"_1099":4299},"Name or ID of the VPC, only required if `router` is provided as a `Name`",{"_1088":36,"_1092":4301,"_1094":4302},"

Delete route

\n",[4303,4304,4305,4307,4308],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":3979,"_1099":4306},"Name or ID of the route",{"_1097":4253,"_1099":4273},{"_1097":2498,"_1099":4299},{"_1088":1134,"_1092":4310,"_1170":1016,"_1094":4311},"

List routes

\n",[4312,4313,4314,4315,4316,4318],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":4253,"_1099":4273},{"_1097":1161,"_1162":4317},[1164,1165,1166],{"_1097":2498,"_1099":4299},{"_1088":1285,"_1092":4320,"_1094":4321},"

Update route

\n",[4322,4323,4324,4325,4326,4327,4328,4329,4330],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":3979,"_1099":4306},{"_1097":4253,"_1099":4273},{"_1097":2498,"_1099":4299},{"_1088":1235,"_1092":4332,"_1094":4333},"

Fetch route

\n",[4334,4335,4336,4337,4338],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":3979,"_1099":4306},{"_1097":4253,"_1099":4273},{"_1097":2498,"_1099":4299},{"_1088":1285,"_1092":4340,"_1094":4341},"

Update router

\n",[4342,4343,4344,4345,4346,4347,4348,4349],{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":4253,"_1099":4273},{"_1097":2498,"_1099":2533},{"_1088":1235,"_1092":4351,"_1094":4352},"

Fetch router

\n",[4353,4354,4355,4356],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":4253,"_1099":4273},{"_1097":2498,"_1099":2533},{"_1088":4358,"_1094":4359,"_1121":4361},"subnet",[4360],{"_1097":1111,"_1099":1112,"_1113":1114},[4362,4381,4389,4398,4411,4424],{"_1088":1246,"_1092":4363,"_1094":4364},"

Create subnet

\n",[4365,4368,4369,4372,4375,4376,4377,4378,4379,4380],{"_1097":4366,"_1099":4367},"custom-router","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.",{"_1097":21},{"_1097":4370,"_1099":4371},"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.",{"_1097":4373,"_1099":4374},"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.",{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":2498,"_1099":2533},{"_1088":36,"_1092":4382,"_1094":4383},"

Delete subnet

\n",[4384,4385,4386,4388],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":4358,"_1099":4387},"Name or ID of the subnet",{"_1097":2498,"_1099":2533},{"_1088":1134,"_1092":4390,"_1094":4391},"

List subnets

\n",[4392,4393,4394,4395,4397],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":1161,"_1162":4396},[1164,1165,1166],{"_1097":2498,"_1099":2533},{"_1088":2287,"_1094":4399,"_1121":4401},[4400],{"_1097":1111,"_1099":1112,"_1113":1114},[4402],{"_1088":1134,"_1092":2320,"_1094":4403},[4404,4405,4406,4407,4409,4410],{"_1097":1141,"_1099":1142},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":1161,"_1162":4408},[1164,1165,1166],{"_1097":4358,"_1099":4387},{"_1097":2498,"_1099":2533},{"_1088":1285,"_1092":4412,"_1094":4413},"

Update subnet

\n",[4414,4416,4417,4418,4419,4420,4421,4422,4423],{"_1097":4366,"_1099":4415},"An optional router, used to direct packets sent from hosts in this subnet to any destination address.",{"_1097":21},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":4358,"_1099":4387},{"_1097":2498,"_1099":2533},{"_1088":1235,"_1092":4425,"_1094":4426},"

Fetch subnet

\n",[4427,4428,4429,4430],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":2496},{"_1097":4358,"_1099":4387},{"_1097":2498,"_1099":2533},{"_1088":1285,"_1092":4432,"_1094":4433},"

Update a VPC

\n",[4434,4435,4436,4437,4438,4439,4440,4441],{"_1097":21},{"_1097":4210},{"_1097":1216,"_1099":1217},{"_1097":1219,"_1099":1220},{"_1097":1088},{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":2498,"_1099":2533},{"_1088":1235,"_1092":4443,"_1094":4444},"

Fetch VPC

\n",[4445,4446,4447],{"_1097":1111,"_1099":1112,"_1113":1114},{"_1097":1622,"_1099":1623},{"_1097":2498,"_1099":2533},"guides",[4450,4454],{"_17":4451,"_4452":4453},"/cli/guides/introduction","title","Introduction",{"_17":4455,"_4452":4456},"/guides/quickstart-cli","Quick Start: CLI","commit",{"_4459":4460,"_4461":4462,"_4463":4464},"sha","5ad103672b7f19633fe43f0bbc72719752799d3d","jsonUrl","https://github.com/oxidecomputer/oxide.rs/blob/5ad103672b7f19633fe43f0bbc72719752799d3d/cli/docs/cli.json","repoUrl","https://github.com/oxidecomputer/oxide.rs/commit/5ad103672b7f19633fe43f0bbc72719752799d3d","routes/cli.$",{"_4467":4083,"_17":4468},"cmd","system/update/repo/list","actionData","errors"]

$oxidesystemupdaterepolist

Options

$
oxide
system update repo list