package
0.1.0-beta8
Repository: https://github.com/oxidecomputer/oxide.go.git
Documentation: pkg.go.dev
# Functions
NewClient creates a new client for the Oxide API.
NewHTTPError returns an error of type *HTTPError if the response status code is 3xx or greater.
# Constants
AddressLotKindInfra represents the AddressLotKind `"infra"`.
AddressLotKindPool represents the AddressLotKind `"pool"`.
AllowedSourceIpsAllowAny represents the AllowedSourceIpsAllow `"any"`.
AllowedSourceIpsAllowList represents the AllowedSourceIpsAllow `"list"`.
AuthzScopeFleet represents the AuthzScope `"fleet"`.
AuthzScopeProject represents the AuthzScope `"project"`.
AuthzScopeSilo represents the AuthzScope `"silo"`.
AuthzScopeViewableToAll represents the AuthzScope `"viewable_to_all"`.
BfdModeMultiHop represents the BfdMode `"multi_hop"`.
BfdModeSingleHop represents the BfdMode `"single_hop"`.
BfdStateAdminDown represents the BfdState `"admin_down"`.
BfdStateDown represents the BfdState `"down"`.
BfdStateInit represents the BfdState `"init"`.
BfdStateUp represents the BfdState `"up"`.
BgpPeerStateActive represents the BgpPeerState `"active"`.
BgpPeerStateConnect represents the BgpPeerState `"connect"`.
BgpPeerStateEstablished represents the BgpPeerState `"established"`.
BgpPeerStateIdle represents the BgpPeerState `"idle"`.
BgpPeerStateOpenConfirm represents the BgpPeerState `"open_confirm"`.
BgpPeerStateOpenSent represents the BgpPeerState `"open_sent"`.
BgpPeerStateSessionSetup represents the BgpPeerState `"session_setup"`.
BinRangedoubleTypeRange represents the BinRangedoubleType `"range"`.
BinRangedoubleTypeRangeFrom represents the BinRangedoubleType `"range_from"`.
BinRangedoubleTypeRangeTo represents the BinRangedoubleType `"range_to"`.
BinRangefloatTypeRange represents the BinRangefloatType `"range"`.
BinRangefloatTypeRangeFrom represents the BinRangefloatType `"range_from"`.
BinRangefloatTypeRangeTo represents the BinRangefloatType `"range_to"`.
BinRangeint16TypeRange represents the BinRangeint16Type `"range"`.
BinRangeint16TypeRangeFrom represents the BinRangeint16Type `"range_from"`.
BinRangeint16TypeRangeTo represents the BinRangeint16Type `"range_to"`.
BinRangeint32TypeRange represents the BinRangeint32Type `"range"`.
BinRangeint32TypeRangeFrom represents the BinRangeint32Type `"range_from"`.
BinRangeint32TypeRangeTo represents the BinRangeint32Type `"range_to"`.
BinRangeint64TypeRange represents the BinRangeint64Type `"range"`.
BinRangeint64TypeRangeFrom represents the BinRangeint64Type `"range_from"`.
BinRangeint64TypeRangeTo represents the BinRangeint64Type `"range_to"`.
BinRangeint8TypeRange represents the BinRangeint8Type `"range"`.
BinRangeint8TypeRangeFrom represents the BinRangeint8Type `"range_from"`.
BinRangeint8TypeRangeTo represents the BinRangeint8Type `"range_to"`.
BinRangeuint16TypeRange represents the BinRangeuint16Type `"range"`.
BinRangeuint16TypeRangeFrom represents the BinRangeuint16Type `"range_from"`.
BinRangeuint16TypeRangeTo represents the BinRangeuint16Type `"range_to"`.
BinRangeuint32TypeRange represents the BinRangeuint32Type `"range"`.
BinRangeuint32TypeRangeFrom represents the BinRangeuint32Type `"range_from"`.
BinRangeuint32TypeRangeTo represents the BinRangeuint32Type `"range_to"`.
BinRangeuint64TypeRange represents the BinRangeuint64Type `"range"`.
BinRangeuint64TypeRangeFrom represents the BinRangeuint64Type `"range_from"`.
BinRangeuint64TypeRangeTo represents the BinRangeuint64Type `"range_to"`.
BinRangeuint8TypeRange represents the BinRangeuint8Type `"range"`.
BinRangeuint8TypeRangeFrom represents the BinRangeuint8Type `"range_from"`.
BinRangeuint8TypeRangeTo represents the BinRangeuint8Type `"range_to"`.
DatumTypeBool represents the DatumType `"bool"`.
DatumTypeBytes represents the DatumType `"bytes"`.
DatumTypeCumulativeF32 represents the DatumType `"cumulative_f32"`.
DatumTypeCumulativeF64 represents the DatumType `"cumulative_f64"`.
DatumTypeCumulativeI64 represents the DatumType `"cumulative_i64"`.
DatumTypeCumulativeU64 represents the DatumType `"cumulative_u64"`.
DatumTypeF32 represents the DatumType `"f32"`.
DatumTypeF64 represents the DatumType `"f64"`.
DatumTypeHistogramF32 represents the DatumType `"histogram_f32"`.
DatumTypeHistogramF64 represents the DatumType `"histogram_f64"`.
DatumTypeHistogramI16 represents the DatumType `"histogram_i16"`.
DatumTypeHistogramI32 represents the DatumType `"histogram_i32"`.
DatumTypeHistogramI64 represents the DatumType `"histogram_i64"`.
DatumTypeHistogramI8 represents the DatumType `"histogram_i8"`.
DatumTypeHistogramU16 represents the DatumType `"histogram_u16"`.
DatumTypeHistogramU32 represents the DatumType `"histogram_u32"`.
DatumTypeHistogramU64 represents the DatumType `"histogram_u64"`.
DatumTypeHistogramU8 represents the DatumType `"histogram_u8"`.
DatumTypeI16 represents the DatumType `"i16"`.
DatumTypeI32 represents the DatumType `"i32"`.
DatumTypeI64 represents the DatumType `"i64"`.
DatumTypeI8 represents the DatumType `"i8"`.
DatumTypeMissing represents the DatumType `"missing"`.
DatumTypeString represents the DatumType `"string"`.
DatumTypeU16 represents the DatumType `"u16"`.
DatumTypeU32 represents the DatumType `"u32"`.
DatumTypeU64 represents the DatumType `"u64"`.
DatumTypeU8 represents the DatumType `"u8"`.
DigestTypeSha256 represents the DigestType `"sha256"`.
DiskMetricNameActivated represents the DiskMetricName `"activated"`.
DiskMetricNameFlush represents the DiskMetricName `"flush"`.
DiskMetricNameRead represents the DiskMetricName `"read"`.
DiskMetricNameReadBytes represents the DiskMetricName `"read_bytes"`.
DiskMetricNameWrite represents the DiskMetricName `"write"`.
DiskMetricNameWriteBytes represents the DiskMetricName `"write_bytes"`.
DiskSourceTypeBlank represents the DiskSourceType `"blank"`.
DiskSourceTypeImage represents the DiskSourceType `"image"`.
DiskSourceTypeImportingBlocks represents the DiskSourceType `"importing_blocks"`.
DiskSourceTypeSnapshot represents the DiskSourceType `"snapshot"`.
DiskStateStateAttached represents the DiskStateState `"attached"`.
DiskStateStateAttaching represents the DiskStateState `"attaching"`.
DiskStateStateCreating represents the DiskStateState `"creating"`.
DiskStateStateDestroyed represents the DiskStateState `"destroyed"`.
DiskStateStateDetached represents the DiskStateState `"detached"`.
DiskStateStateDetaching represents the DiskStateState `"detaching"`.
DiskStateStateFaulted represents the DiskStateState `"faulted"`.
DiskStateStateFinalizing represents the DiskStateState `"finalizing"`.
DiskStateStateImportingFromBulkWrites represents the DiskStateState `"importing_from_bulk_writes"`.
DiskStateStateImportingFromUrl represents the DiskStateState `"importing_from_url"`.
DiskStateStateImportReady represents the DiskStateState `"import_ready"`.
DiskStateStateMaintenance represents the DiskStateState `"maintenance"`.
ExternalIpCreateTypeEphemeral represents the ExternalIpCreateType `"ephemeral"`.
ExternalIpCreateTypeFloating represents the ExternalIpCreateType `"floating"`.
ExternalIpKindEphemeral represents the ExternalIpKind `"ephemeral"`.
ExternalIpKindFloating represents the ExternalIpKind `"floating"`.
FieldSourceMetric represents the FieldSource `"metric"`.
FieldSourceTarget represents the FieldSource `"target"`.
FieldTypeBool represents the FieldType `"bool"`.
FieldTypeI16 represents the FieldType `"i16"`.
FieldTypeI32 represents the FieldType `"i32"`.
FieldTypeI64 represents the FieldType `"i64"`.
FieldTypeI8 represents the FieldType `"i8"`.
FieldTypeIpAddr represents the FieldType `"ip_addr"`.
FieldTypeString represents the FieldType `"string"`.
FieldTypeU16 represents the FieldType `"u16"`.
FieldTypeU32 represents the FieldType `"u32"`.
FieldTypeU64 represents the FieldType `"u64"`.
FieldTypeU8 represents the FieldType `"u8"`.
FieldTypeUuid represents the FieldType `"uuid"`.
FieldValueTypeBool represents the FieldValueType `"bool"`.
FieldValueTypeI16 represents the FieldValueType `"i16"`.
FieldValueTypeI32 represents the FieldValueType `"i32"`.
FieldValueTypeI64 represents the FieldValueType `"i64"`.
FieldValueTypeI8 represents the FieldValueType `"i8"`.
FieldValueTypeIpAddr represents the FieldValueType `"ip_addr"`.
FieldValueTypeString represents the FieldValueType `"string"`.
FieldValueTypeU16 represents the FieldValueType `"u16"`.
FieldValueTypeU32 represents the FieldValueType `"u32"`.
FieldValueTypeU64 represents the FieldValueType `"u64"`.
FieldValueTypeU8 represents the FieldValueType `"u8"`.
FieldValueTypeUuid represents the FieldValueType `"uuid"`.
FleetRoleAdmin represents the FleetRole `"admin"`.
FleetRoleCollaborator represents the FleetRole `"collaborator"`.
FleetRoleViewer represents the FleetRole `"viewer"`.
FloatingIpParentKindInstance represents the FloatingIpParentKind `"instance"`.
HostEnvVar is the environment variable that contains the host.
IdentityProviderTypeSaml represents the IdentityProviderType `"saml"`.
IdentityTypeSiloGroup represents the IdentityType `"silo_group"`.
IdentityTypeSiloUser represents the IdentityType `"silo_user"`.
IdpMetadataSourceTypeBase64EncodedXml represents the IdpMetadataSourceType `"base64_encoded_xml"`.
IdpMetadataSourceTypeUrl represents the IdpMetadataSourceType `"url"`.
IdSortModeIdAscending represents the IdSortMode `"id_ascending"`.
ImageSourceTypeSnapshot represents the ImageSourceType `"snapshot"`.
ImageSourceTypeYouCanBootAnythingAsLongAsItsAlpine represents the ImageSourceType `"you_can_boot_anything_as_long_as_its_alpine"`.
ImportExportPolicyTypeAllow represents the ImportExportPolicyType `"allow"`.
ImportExportPolicyTypeNoFiltering represents the ImportExportPolicyType `"no_filtering"`.
InstanceDiskAttachmentTypeAttach represents the InstanceDiskAttachmentType `"attach"`.
InstanceDiskAttachmentTypeCreate represents the InstanceDiskAttachmentType `"create"`.
InstanceNetworkInterfaceAttachmentTypeCreate represents the InstanceNetworkInterfaceAttachmentType `"create"`.
InstanceNetworkInterfaceAttachmentTypeDefault represents the InstanceNetworkInterfaceAttachmentType `"default"`.
InstanceNetworkInterfaceAttachmentTypeNone represents the InstanceNetworkInterfaceAttachmentType `"none"`.
InstanceStateCreating represents the InstanceState `"creating"`.
InstanceStateDestroyed represents the InstanceState `"destroyed"`.
InstanceStateFailed represents the InstanceState `"failed"`.
InstanceStateMigrating represents the InstanceState `"migrating"`.
InstanceStateRebooting represents the InstanceState `"rebooting"`.
InstanceStateRepairing represents the InstanceState `"repairing"`.
InstanceStateRunning represents the InstanceState `"running"`.
InstanceStateStarting represents the InstanceState `"starting"`.
InstanceStateStopped represents the InstanceState `"stopped"`.
InstanceStateStopping represents the InstanceState `"stopping"`.
LinkFecFirecode represents the LinkFec `"firecode"`.
LinkFecNone represents the LinkFec `"none"`.
LinkFecRs represents the LinkFec `"rs"`.
LinkSpeedSpeed0G represents the LinkSpeed `"speed0_g"`.
LinkSpeedSpeed100G represents the LinkSpeed `"speed100_g"`.
LinkSpeedSpeed10G represents the LinkSpeed `"speed10_g"`.
LinkSpeedSpeed1G represents the LinkSpeed `"speed1_g"`.
LinkSpeedSpeed200G represents the LinkSpeed `"speed200_g"`.
LinkSpeedSpeed25G represents the LinkSpeed `"speed25_g"`.
LinkSpeedSpeed400G represents the LinkSpeed `"speed400_g"`.
LinkSpeedSpeed40G represents the LinkSpeed `"speed40_g"`.
LinkSpeedSpeed50G represents the LinkSpeed `"speed50_g"`.
MetricTypeCumulative represents the MetricType `"cumulative"`.
MetricTypeDelta represents the MetricType `"delta"`.
MetricTypeGauge represents the MetricType `"gauge"`.
NameOrIdSortModeIdAscending represents the NameOrIdSortMode `"id_ascending"`.
NameOrIdSortModeNameAscending represents the NameOrIdSortMode `"name_ascending"`.
NameOrIdSortModeNameDescending represents the NameOrIdSortMode `"name_descending"`.
NameSortModeNameAscending represents the NameSortMode `"name_ascending"`.
NetworkInterfaceKindTypeInstance represents the NetworkInterfaceKindType `"instance"`.
NetworkInterfaceKindTypeProbe represents the NetworkInterfaceKindType `"probe"`.
NetworkInterfaceKindTypeService represents the NetworkInterfaceKindType `"service"`.
PaginationOrderAscending represents the PaginationOrder `"ascending"`.
PaginationOrderDescending represents the PaginationOrder `"descending"`.
PhysicalDiskKindM2 represents the PhysicalDiskKind `"m2"`.
PhysicalDiskKindU2 represents the PhysicalDiskKind `"u2"`.
PhysicalDiskPolicyKindExpunged represents the PhysicalDiskPolicyKind `"expunged"`.
PhysicalDiskPolicyKindInService represents the PhysicalDiskPolicyKind `"in_service"`.
PhysicalDiskStateActive represents the PhysicalDiskState `"active"`.
PhysicalDiskStateDecommissioned represents the PhysicalDiskState `"decommissioned"`.
PingStatusOk represents the PingStatus `"ok"`.
ProbeExternalIpKindEphemeral represents the ProbeExternalIpKind `"ephemeral"`.
ProbeExternalIpKindFloating represents the ProbeExternalIpKind `"floating"`.
ProbeExternalIpKindSnat represents the ProbeExternalIpKind `"snat"`.
ProjectRoleAdmin represents the ProjectRole `"admin"`.
ProjectRoleCollaborator represents the ProjectRole `"collaborator"`.
ProjectRoleViewer represents the ProjectRole `"viewer"`.
RouteDestinationTypeIp represents the RouteDestinationType `"ip"`.
RouteDestinationTypeIpNet represents the RouteDestinationType `"ip_net"`.
RouteDestinationTypeSubnet represents the RouteDestinationType `"subnet"`.
RouteDestinationTypeVpc represents the RouteDestinationType `"vpc"`.
RouterRouteKindCustom represents the RouterRouteKind `"custom"`.
RouterRouteKindDefault represents the RouterRouteKind `"default"`.
RouterRouteKindVpcPeering represents the RouterRouteKind `"vpc_peering"`.
RouterRouteKindVpcSubnet represents the RouterRouteKind `"vpc_subnet"`.
RouteTargetTypeDrop represents the RouteTargetType `"drop"`.
RouteTargetTypeInstance represents the RouteTargetType `"instance"`.
RouteTargetTypeInternetGateway represents the RouteTargetType `"internet_gateway"`.
RouteTargetTypeIp represents the RouteTargetType `"ip"`.
RouteTargetTypeSubnet represents the RouteTargetType `"subnet"`.
RouteTargetTypeVpc represents the RouteTargetType `"vpc"`.
ServiceUsingCertificateExternalApi represents the ServiceUsingCertificate `"external_api"`.
SiloIdentityModeLocalOnly represents the SiloIdentityMode `"local_only"`.
SiloIdentityModeSamlJit represents the SiloIdentityMode `"saml_jit"`.
SiloRoleAdmin represents the SiloRole `"admin"`.
SiloRoleCollaborator represents the SiloRole `"collaborator"`.
SiloRoleViewer represents the SiloRole `"viewer"`.
SledPolicyKindExpunged represents the SledPolicyKind `"expunged"`.
SledPolicyKindInService represents the SledPolicyKind `"in_service"`.
SledProvisionPolicyNonProvisionable represents the SledProvisionPolicy `"non_provisionable"`.
SledProvisionPolicyProvisionable represents the SledProvisionPolicy `"provisionable"`.
SledStateActive represents the SledState `"active"`.
SledStateDecommissioned represents the SledState `"decommissioned"`.
SnapshotStateCreating represents the SnapshotState `"creating"`.
SnapshotStateDestroyed represents the SnapshotState `"destroyed"`.
SnapshotStateFaulted represents the SnapshotState `"faulted"`.
SnapshotStateReady represents the SnapshotState `"ready"`.
SwitchInterfaceKind2Loopback represents the SwitchInterfaceKind2 `"loopback"`.
SwitchInterfaceKind2Primary represents the SwitchInterfaceKind2 `"primary"`.
SwitchInterfaceKind2Vlan represents the SwitchInterfaceKind2 `"vlan"`.
SwitchInterfaceKindTypeLoopback represents the SwitchInterfaceKindType `"loopback"`.
SwitchInterfaceKindTypePrimary represents the SwitchInterfaceKindType `"primary"`.
SwitchInterfaceKindTypeVlan represents the SwitchInterfaceKindType `"vlan"`.
SwitchLocationSwitch0 represents the SwitchLocation `"switch0"`.
SwitchLocationSwitch1 represents the SwitchLocation `"switch1"`.
SwitchPortGeometry2Qsfp28X1 represents the SwitchPortGeometry2 `"qsfp28x1"`.
SwitchPortGeometry2Qsfp28X2 represents the SwitchPortGeometry2 `"qsfp28x2"`.
SwitchPortGeometry2Sfp28X4 represents the SwitchPortGeometry2 `"sfp28x4"`.
SwitchPortGeometryQsfp28X1 represents the SwitchPortGeometry `"qsfp28x1"`.
SwitchPortGeometryQsfp28X2 represents the SwitchPortGeometry `"qsfp28x2"`.
SwitchPortGeometrySfp28X4 represents the SwitchPortGeometry `"sfp28x4"`.
SystemMetricNameCpusProvisioned represents the SystemMetricName `"cpus_provisioned"`.
SystemMetricNameRamProvisioned represents the SystemMetricName `"ram_provisioned"`.
SystemMetricNameVirtualDiskSpaceProvisioned represents the SystemMetricName `"virtual_disk_space_provisioned"`.
TokenEnvVar is the environment variable that contains the token.
UnitsAmps represents the Units `"amps"`.
UnitsBytes represents the Units `"bytes"`.
UnitsCount represents the Units `"count"`.
UnitsDegreesCelsius represents the Units `"degrees_celsius"`.
UnitsNanoseconds represents the Units `"nanoseconds"`.
UnitsNone represents the Units `"none"`.
UnitsRpm represents the Units `"rpm"`.
UnitsSeconds represents the Units `"seconds"`.
UnitsVolts represents the Units `"volts"`.
UnitsWatts represents the Units `"watts"`.
UserPasswordModeLoginDisallowed represents the UserPasswordMode `"login_disallowed"`.
UserPasswordModePassword represents the UserPasswordMode `"password"`.
ValueArrayTypeBoolean represents the ValueArrayType `"boolean"`.
ValueArrayTypeDouble represents the ValueArrayType `"double"`.
ValueArrayTypeDoubleDistribution represents the ValueArrayType `"double_distribution"`.
ValueArrayTypeInteger represents the ValueArrayType `"integer"`.
ValueArrayTypeIntegerDistribution represents the ValueArrayType `"integer_distribution"`.
ValueArrayTypeString represents the ValueArrayType `"string"`.
VpcFirewallRuleActionAllow represents the VpcFirewallRuleAction `"allow"`.
VpcFirewallRuleActionDeny represents the VpcFirewallRuleAction `"deny"`.
VpcFirewallRuleDirectionInbound represents the VpcFirewallRuleDirection `"inbound"`.
VpcFirewallRuleDirectionOutbound represents the VpcFirewallRuleDirection `"outbound"`.
VpcFirewallRuleHostFilterTypeInstance represents the VpcFirewallRuleHostFilterType `"instance"`.
VpcFirewallRuleHostFilterTypeIp represents the VpcFirewallRuleHostFilterType `"ip"`.
VpcFirewallRuleHostFilterTypeIpNet represents the VpcFirewallRuleHostFilterType `"ip_net"`.
VpcFirewallRuleHostFilterTypeSubnet represents the VpcFirewallRuleHostFilterType `"subnet"`.
VpcFirewallRuleHostFilterTypeVpc represents the VpcFirewallRuleHostFilterType `"vpc"`.
VpcFirewallRuleProtocolIcmp represents the VpcFirewallRuleProtocol `"ICMP"`.
VpcFirewallRuleProtocolTcp represents the VpcFirewallRuleProtocol `"TCP"`.
VpcFirewallRuleProtocolUdp represents the VpcFirewallRuleProtocol `"UDP"`.
VpcFirewallRuleStatusDisabled represents the VpcFirewallRuleStatus `"disabled"`.
VpcFirewallRuleStatusEnabled represents the VpcFirewallRuleStatus `"enabled"`.
VpcFirewallRuleTargetTypeInstance represents the VpcFirewallRuleTargetType `"instance"`.
VpcFirewallRuleTargetTypeIp represents the VpcFirewallRuleTargetType `"ip"`.
VpcFirewallRuleTargetTypeIpNet represents the VpcFirewallRuleTargetType `"ip_net"`.
VpcFirewallRuleTargetTypeSubnet represents the VpcFirewallRuleTargetType `"subnet"`.
VpcFirewallRuleTargetTypeVpc represents the VpcFirewallRuleTargetType `"vpc"`.
VpcRouterKindCustom represents the VpcRouterKind `"custom"`.
VpcRouterKindSystem represents the VpcRouterKind `"system"`.
# Variables
AddressLotKindCollection is the collection of all AddressLotKind values.
AllowedSourceIpsAllowCollection is the collection of all AllowedSourceIpsAllow values.
AuthzScopeCollection is the collection of all AuthzScope values.
BfdModeCollection is the collection of all BfdMode values.
BfdStateCollection is the collection of all BfdState values.
BgpPeerStateCollection is the collection of all BgpPeerState values.
BinRangedoubleTypeCollection is the collection of all BinRangedoubleType values.
BinRangefloatTypeCollection is the collection of all BinRangefloatType values.
BinRangeint16TypeCollection is the collection of all BinRangeint16Type values.
BinRangeint32TypeCollection is the collection of all BinRangeint32Type values.
BinRangeint64TypeCollection is the collection of all BinRangeint64Type values.
BinRangeint8TypeCollection is the collection of all BinRangeint8Type values.
BinRangeuint16TypeCollection is the collection of all BinRangeuint16Type values.
BinRangeuint32TypeCollection is the collection of all BinRangeuint32Type values.
BinRangeuint64TypeCollection is the collection of all BinRangeuint64Type values.
BinRangeuint8TypeCollection is the collection of all BinRangeuint8Type values.
DatumTypeCollection is the collection of all DatumType values.
DigestTypeCollection is the collection of all DigestType values.
DiskMetricNameCollection is the collection of all DiskMetricName values.
DiskSourceTypeCollection is the collection of all DiskSourceType values.
DiskStateStateCollection is the collection of all DiskStateState values.
ExternalIpCreateTypeCollection is the collection of all ExternalIpCreateType values.
ExternalIpKindCollection is the collection of all ExternalIpKind values.
FieldSourceCollection is the collection of all FieldSource values.
FieldTypeCollection is the collection of all FieldType values.
FieldValueTypeCollection is the collection of all FieldValueType values.
FleetRoleCollection is the collection of all FleetRole values.
FloatingIpParentKindCollection is the collection of all FloatingIpParentKind values.
IdentityProviderTypeCollection is the collection of all IdentityProviderType values.
IdentityTypeCollection is the collection of all IdentityType values.
IdpMetadataSourceTypeCollection is the collection of all IdpMetadataSourceType values.
IdSortModeCollection is the collection of all IdSortMode values.
ImageSourceTypeCollection is the collection of all ImageSourceType values.
ImportExportPolicyTypeCollection is the collection of all ImportExportPolicyType values.
InstanceDiskAttachmentTypeCollection is the collection of all InstanceDiskAttachmentType values.
InstanceNetworkInterfaceAttachmentTypeCollection is the collection of all InstanceNetworkInterfaceAttachmentType values.
InstanceStateCollection is the collection of all InstanceState values.
LinkFecCollection is the collection of all LinkFec values.
LinkSpeedCollection is the collection of all LinkSpeed values.
MetricTypeCollection is the collection of all MetricType values.
NameOrIdSortModeCollection is the collection of all NameOrIdSortMode values.
NameSortModeCollection is the collection of all NameSortMode values.
NetworkInterfaceKindTypeCollection is the collection of all NetworkInterfaceKindType values.
PaginationOrderCollection is the collection of all PaginationOrder values.
PhysicalDiskKindCollection is the collection of all PhysicalDiskKind values.
PhysicalDiskPolicyKindCollection is the collection of all PhysicalDiskPolicyKind values.
PhysicalDiskStateCollection is the collection of all PhysicalDiskState values.
PingStatusCollection is the collection of all PingStatus values.
ProbeExternalIpKindCollection is the collection of all ProbeExternalIpKind values.
ProjectRoleCollection is the collection of all ProjectRole values.
RouteDestinationTypeCollection is the collection of all RouteDestinationType values.
RouterRouteKindCollection is the collection of all RouterRouteKind values.
RouteTargetTypeCollection is the collection of all RouteTargetType values.
ServiceUsingCertificateCollection is the collection of all ServiceUsingCertificate values.
SiloIdentityModeCollection is the collection of all SiloIdentityMode values.
SiloRoleCollection is the collection of all SiloRole values.
SledPolicyKindCollection is the collection of all SledPolicyKind values.
SledProvisionPolicyCollection is the collection of all SledProvisionPolicy values.
SledStateCollection is the collection of all SledState values.
SnapshotStateCollection is the collection of all SnapshotState values.
SwitchInterfaceKind2Collection is the collection of all SwitchInterfaceKind2 values.
SwitchInterfaceKindTypeCollection is the collection of all SwitchInterfaceKindType values.
SwitchLocationCollection is the collection of all SwitchLocation values.
SwitchPortGeometry2Collection is the collection of all SwitchPortGeometry2 values.
SwitchPortGeometryCollection is the collection of all SwitchPortGeometry values.
SystemMetricNameCollection is the collection of all SystemMetricName values.
UnitsCollection is the collection of all Units values.
UserPasswordModeCollection is the collection of all UserPasswordMode values.
ValueArrayTypeCollection is the collection of all ValueArrayType values.
VpcFirewallRuleActionCollection is the collection of all VpcFirewallRuleAction values.
VpcFirewallRuleDirectionCollection is the collection of all VpcFirewallRuleDirection values.
VpcFirewallRuleHostFilterTypeCollection is the collection of all VpcFirewallRuleHostFilterType values.
VpcFirewallRuleProtocolCollection is the collection of all VpcFirewallRuleProtocol values.
VpcFirewallRuleStatusCollection is the collection of all VpcFirewallRuleStatus values.
VpcFirewallRuleTargetTypeCollection is the collection of all VpcFirewallRuleTargetType values.
VpcRouterKindCollection is the collection of all VpcRouterKind values.
# Structs
Address is an address tied to an address lot.
AddressConfig is a set of addresses associated with a port configuration.
AddressLot is represents an address lot object, containing the id of the lot that can be used in other API calls.
AddressLotBlock is an address lot block is a part of an address lot and contains a range of addresses.
AddressLotBlockCreate is parameters for creating an address lot block.
AddressLotBlockResultsPage is a single page of results
Required fields: - Items.
AddressLotCreate is parameters for creating an address lot.
AddressLotCreateResponse is an address lot and associated blocks resulting from creating an address lot.
AddressLotResultsPage is a single page of results
Required fields: - Items.
AggregateBgpMessageHistory is bGP message history for rack switches.
AllowedSourceIps is description of source IPs allowed to reach rack services.
AllowedSourceIpsAny is allow traffic from any external IP address.
AllowedSourceIpsList is restrict access to a specific set of source IP addresses or subnets.
AllowList is allowlist of IPs or subnets that can make requests to user-facing services.
AllowListUpdate is parameters for updating allowed source IPs
Required fields: - AllowedIps.
Baseboard is properties that uniquely identify an Oxide hardware component
Required fields: - Part - Revision - Serial.
BfdSessionDisable is information needed to disable a BFD session
Required fields: - Remote - Switch.
BfdSessionEnable is information about a bidirectional forwarding detection (BFD) session.
BfdStatus is the type definition for a BfdStatus.
BgpAnnouncement is a BGP announcement tied to an address lot block.
BgpAnnouncementCreate is a BGP announcement tied to a particular address lot block.
BgpAnnounceSet is represents a BGP announce set by id.
BgpAnnounceSetCreate is parameters for creating a named set of BGP announcements.
BgpConfig is a base BGP configuration.
BgpConfigCreate is parameters for creating a BGP configuration.
BgpConfigResultsPage is a single page of results
Required fields: - Items.
BgpExported is the current status of a BGP peer.
BgpImportedRouteIpv4 is a route imported from a BGP peer.
BgpPeer is a BGP peer configuration for an interface.
BgpPeerConfig is the type definition for a BgpPeerConfig.
BgpPeerStatus is the current status of a BGP peer.
Bindouble is type storing bin edges and a count of samples within it.
Binfloat is type storing bin edges and a count of samples within it.
Binint16 is type storing bin edges and a count of samples within it.
Binint32 is type storing bin edges and a count of samples within it.
Binint64 is type storing bin edges and a count of samples within it.
Binint8 is type storing bin edges and a count of samples within it.
BinRangedouble is a type storing a range over `T`.
BinRangedoubleRange is a range bounded inclusively below and exclusively above, `start..end`.
BinRangedoubleRangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangedoubleRangeTo is a range unbounded below and exclusively above, `..end`.
BinRangefloat is a type storing a range over `T`.
BinRangefloatRange is a range bounded inclusively below and exclusively above, `start..end`.
BinRangefloatRangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangefloatRangeTo is a range unbounded below and exclusively above, `..end`.
BinRangeint16 is a type storing a range over `T`.
BinRangeint16Range is a range bounded inclusively below and exclusively above, `start..end`.
BinRangeint16RangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangeint16RangeTo is a range unbounded below and exclusively above, `..end`.
BinRangeint32 is a type storing a range over `T`.
BinRangeint32Range is a range bounded inclusively below and exclusively above, `start..end`.
BinRangeint32RangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangeint32RangeTo is a range unbounded below and exclusively above, `..end`.
BinRangeint64 is a type storing a range over `T`.
BinRangeint64Range is a range bounded inclusively below and exclusively above, `start..end`.
BinRangeint64RangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangeint64RangeTo is a range unbounded below and exclusively above, `..end`.
BinRangeint8 is a type storing a range over `T`.
BinRangeint8Range is a range bounded inclusively below and exclusively above, `start..end`.
BinRangeint8RangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangeint8RangeTo is a range unbounded below and exclusively above, `..end`.
BinRangeuint16 is a type storing a range over `T`.
BinRangeuint16Range is a range bounded inclusively below and exclusively above, `start..end`.
BinRangeuint16RangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangeuint16RangeTo is a range unbounded below and exclusively above, `..end`.
BinRangeuint32 is a type storing a range over `T`.
BinRangeuint32Range is a range bounded inclusively below and exclusively above, `start..end`.
BinRangeuint32RangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangeuint32RangeTo is a range unbounded below and exclusively above, `..end`.
BinRangeuint64 is a type storing a range over `T`.
BinRangeuint64Range is a range bounded inclusively below and exclusively above, `start..end`.
BinRangeuint64RangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangeuint64RangeTo is a range unbounded below and exclusively above, `..end`.
BinRangeuint8 is a type storing a range over `T`.
BinRangeuint8Range is a range bounded inclusively below and exclusively above, `start..end`.
BinRangeuint8RangeFrom is a range bounded inclusively below and unbounded above, `start..`.
BinRangeuint8RangeTo is a range unbounded below and exclusively above, `..end`.
Binuint16 is type storing bin edges and a count of samples within it.
Binuint32 is type storing bin edges and a count of samples within it.
Binuint64 is type storing bin edges and a count of samples within it.
Binuint8 is type storing bin edges and a count of samples within it.
Certificate is view of a Certificate
Required fields: - Cert - Description - Id - Name - Service - TimeCreated - TimeModified.
CertificateCreate is create-time parameters for a `Certificate`
Required fields: - Cert - Description - Key - Name - Service.
CertificateCreateParams is the request parameters for CertificateCreate
Required fields: - Body.
CertificateDeleteParams is the request parameters for CertificateDelete
Required fields: - Certificate.
CertificateListParams is the request parameters for CertificateList.
CertificateResultsPage is a single page of results
Required fields: - Items.
CertificateViewParams is the request parameters for CertificateView
Required fields: - Certificate.
Client which conforms to the OpenAPI3 specification for this service.
Config is the configuration that can be set on a Client.
Cumulativedouble is a cumulative or counter data type.
Cumulativefloat is a cumulative or counter data type.
Cumulativeint64 is a cumulative or counter data type.
Cumulativeuint64 is a cumulative or counter data type.
CurrentUser is info about the current user
Required fields: - DisplayName - Id - SiloId - SiloName.
CurrentUserGroupsParams is the request parameters for CurrentUserGroups.
CurrentUserSshKeyCreateParams is the request parameters for CurrentUserSshKeyCreate
Required fields: - Body.
CurrentUserSshKeyDeleteParams is the request parameters for CurrentUserSshKeyDelete
Required fields: - SshKey.
CurrentUserSshKeyListParams is the request parameters for CurrentUserSshKeyList.
CurrentUserSshKeyViewParams is the request parameters for CurrentUserSshKeyView
Required fields: - SshKey.
Datum is a `Datum` is a single sampled data point from a metric.
DatumBool is the type definition for a DatumBool.
DatumBytes is the type definition for a DatumBytes.
DatumCumulativeF32 is the type definition for a DatumCumulativeF32.
DatumCumulativeF64 is the type definition for a DatumCumulativeF64.
DatumCumulativeI64 is the type definition for a DatumCumulativeI64.
DatumCumulativeU64 is the type definition for a DatumCumulativeU64.
DatumF32 is the type definition for a DatumF32.
DatumF64 is the type definition for a DatumF64.
DatumHistogramF32 is the type definition for a DatumHistogramF32.
DatumHistogramF64 is the type definition for a DatumHistogramF64.
DatumHistogramI16 is the type definition for a DatumHistogramI16.
DatumHistogramI32 is the type definition for a DatumHistogramI32.
DatumHistogramI64 is the type definition for a DatumHistogramI64.
DatumHistogramI8 is the type definition for a DatumHistogramI8.
DatumHistogramU16 is the type definition for a DatumHistogramU16.
DatumHistogramU32 is the type definition for a DatumHistogramU32.
DatumHistogramU64 is the type definition for a DatumHistogramU64.
DatumHistogramU8 is the type definition for a DatumHistogramU8.
DatumI16 is the type definition for a DatumI16.
DatumI32 is the type definition for a DatumI32.
DatumI64 is the type definition for a DatumI64.
DatumI8 is the type definition for a DatumI8.
DatumMissing is the type definition for a DatumMissing.
DatumString is the type definition for a DatumString.
DatumU16 is the type definition for a DatumU16.
DatumU32 is the type definition for a DatumU32.
DatumU64 is the type definition for a DatumU64.
DatumU8 is the type definition for a DatumU8.
DerEncodedKeyPair is the type definition for a DerEncodedKeyPair.
DeviceAccessTokenParams is the request parameters for DeviceAccessToken
Required fields: - Body.
DeviceAccessTokenRequest is the type definition for a DeviceAccessTokenRequest.
DeviceAuthConfirmParams is the request parameters for DeviceAuthConfirm
Required fields: - Body.
DeviceAuthRequest is the type definition for a DeviceAuthRequest.
DeviceAuthRequestParams is the request parameters for DeviceAuthRequest
Required fields: - Body.
DeviceAuthVerify is the type definition for a DeviceAuthVerify.
Digest is the type definition for a Digest.
DigestSha256 is the type definition for a DigestSha256.
Disk is view of a Disk
Required fields: - BlockSize - Description - DevicePath - Id - Name - ProjectId - Size - State - TimeCreated - TimeModified.
DiskBulkWriteImportParams is the request parameters for DiskBulkWriteImport
Required fields: - Disk - Body.
DiskBulkWriteImportStartParams is the request parameters for DiskBulkWriteImportStart
Required fields: - Disk.
DiskBulkWriteImportStopParams is the request parameters for DiskBulkWriteImportStop
Required fields: - Disk.
DiskCreate is create-time parameters for a `Disk`
Required fields: - Description - DiskSource - Name - Size.
DiskCreateParams is the request parameters for DiskCreate
Required fields: - Project - Body.
DiskDeleteParams is the request parameters for DiskDelete
Required fields: - Disk.
DiskFinalizeImportParams is the request parameters for DiskFinalizeImport
Required fields: - Disk - Body.
DiskListParams is the request parameters for DiskList
Required fields: - Project.
DiskMetricsListParams is the request parameters for DiskMetricsList
Required fields: - EndTime - StartTime - Disk - Metric.
DiskPath is the type definition for a DiskPath.
DiskResultsPage is a single page of results
Required fields: - Items.
DiskSource is different sources for a disk.
DiskSourceBlank is create a blank disk
Required fields: - BlockSize - Type.
DiskSourceImage is create a disk from an image
Required fields: - ImageId - Type.
DiskSourceImportingBlocks is create a blank disk that will accept bulk writes or pull blocks from an external source.
DiskSourceSnapshot is create a disk from a disk snapshot
Required fields: - SnapshotId - Type.
DiskState is state of a Disk.
DiskStateAttached is disk is attached to the given Instance
Required fields: - Instance - State.
DiskStateAttaching is disk is being attached to the given Instance
Required fields: - Instance - State.
DiskStateCreating is disk is being initialized
Required fields: - State.
DiskStateDestroyed is disk has been destroyed
Required fields: - State.
DiskStateDetached is disk is ready but detached from any Instance
Required fields: - State.
DiskStateDetaching is disk is being detached from the given Instance
Required fields: - Instance - State.
DiskStateFaulted is disk is unavailable
Required fields: - State.
DiskStateFinalizing is disk is being finalized to state Detached
Required fields: - State.
DiskStateImportingFromBulkWrites is disk is importing blocks from bulk writes
Required fields: - State.
DiskStateImportingFromUrl is disk is importing blocks from a URL
Required fields: - State.
DiskStateImportReady is disk is ready to receive blocks from an external source
Required fields: - State.
DiskStateMaintenance is disk is undergoing maintenance
Required fields: - State.
DiskViewParams is the request parameters for DiskView
Required fields: - Disk.
Distributiondouble is a distribution is a sequence of bins and counts in those bins, and some statistical information tracked to compute the mean, standard deviation, and quantile estimates.
Distributionint64 is a distribution is a sequence of bins and counts in those bins, and some statistical information tracked to compute the mean, standard deviation, and quantile estimates.
EphemeralIpCreate is parameters for creating an ephemeral IP address for an instance.
Error is error information from a response.
ExternalIp is the type definition for a ExternalIp.
ExternalIpCreate is parameters for creating an external IP address for instances.
ExternalIpCreateEphemeral is an IP address providing both inbound and outbound access.
ExternalIpCreateFloating is an IP address providing both inbound and outbound access.
ExternalIpEphemeral is the type definition for a ExternalIpEphemeral.
ExternalIpFloating is a Floating IP is a well-known IP address which can be attached and detached from instances.
ExternalIpResultsPage is a single page of results
Required fields: - Items.
FieldSchema is the name and type information for a field of a timeseries schema.
FieldValue is the `FieldValue` contains the value of a target or metric field.
FieldValueBool is the type definition for a FieldValueBool.
FieldValueI16 is the type definition for a FieldValueI16.
FieldValueI32 is the type definition for a FieldValueI32.
FieldValueI64 is the type definition for a FieldValueI64.
FieldValueI8 is the type definition for a FieldValueI8.
FieldValueIpAddr is the type definition for a FieldValueIpAddr.
FieldValueString is the type definition for a FieldValueString.
FieldValueU16 is the type definition for a FieldValueU16.
FieldValueU32 is the type definition for a FieldValueU32.
FieldValueU64 is the type definition for a FieldValueU64.
FieldValueU8 is the type definition for a FieldValueU8.
FieldValueUuid is the type definition for a FieldValueUuid.
FinalizeDisk is parameters for finalizing a disk.
FleetRolePolicy is policy for a particular resource
Note that the Policy only describes access granted explicitly for this resource.
FleetRoleRoleAssignment is describes the assignment of a particular role on a particular resource to a particular identity (user, group, etc.)
The resource is not part of this structure.
FloatingIp is a Floating IP is a well-known IP address which can be attached and detached from instances.
FloatingIpAttach is parameters for attaching a floating IP address to another resource
Required fields: - Kind - Parent.
FloatingIpAttachParams is the request parameters for FloatingIpAttach
Required fields: - FloatingIp - Body.
FloatingIpCreate is parameters for creating a new floating IP address for instances.
FloatingIpCreateParams is the request parameters for FloatingIpCreate
Required fields: - Project - Body.
FloatingIpDeleteParams is the request parameters for FloatingIpDelete
Required fields: - FloatingIp.
FloatingIpDetachParams is the request parameters for FloatingIpDetach
Required fields: - FloatingIp.
FloatingIpListParams is the request parameters for FloatingIpList
Required fields: - Project.
FloatingIpResultsPage is a single page of results
Required fields: - Items.
FloatingIpUpdate is updateable identity-related parameters.
FloatingIpUpdateParams is the request parameters for FloatingIpUpdate
Required fields: - FloatingIp - Body.
FloatingIpViewParams is the request parameters for FloatingIpView
Required fields: - FloatingIp.
Group is view of a Group
Required fields: - DisplayName - Id - SiloId.
GroupListParams is the request parameters for GroupList.
GroupResultsPage is a single page of results
Required fields: - Items.
GroupViewParams is the request parameters for GroupView
Required fields: - GroupId.
Histogramdouble is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramfloat is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramint16 is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramint32 is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramint64 is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramint8 is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramuint16 is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramuint32 is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramuint64 is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
Histogramuint8 is histogram metric
A histogram maintains the count of any number of samples, over a set of bins.
HTTPError is an error returned by a failed API call.
IdentityProvider is view of an Identity Provider
Required fields: - Description - Id - Name - ProviderType - TimeCreated - TimeModified.
IdentityProviderResultsPage is a single page of results
Required fields: - Items.
IdpMetadataSource is the type definition for a IdpMetadataSource.
IdpMetadataSourceBase64EncodedXml is the type definition for a IdpMetadataSourceBase64EncodedXml.
IdpMetadataSourceUrl is the type definition for a IdpMetadataSourceUrl.
Image is view of an image
If `project_id` is present then the image is only visible inside that project.
ImageCreate is create-time parameters for an `Image`
Required fields: - Description - Name - Os - Source - Version.
ImageCreateParams is the request parameters for ImageCreate
Required fields: - Body.
ImageDeleteParams is the request parameters for ImageDelete
Required fields: - Image.
ImageDemoteParams is the request parameters for ImageDemote
Required fields: - Image - Project.
ImageListParams is the request parameters for ImageList.
ImagePromoteParams is the request parameters for ImagePromote
Required fields: - Image.
ImageResultsPage is a single page of results
Required fields: - Items.
ImageSource is the source of the underlying image.
ImageSourceSnapshot is the type definition for a ImageSourceSnapshot.
ImageSourceYouCanBootAnythingAsLongAsItsAlpine is boot the Alpine ISO that ships with the Propolis zone.
ImageViewParams is the request parameters for ImageView
Required fields: - Image.
ImportBlocksBulkWrite is parameters for importing blocks with a bulk write
Required fields: - Base64EncodedData - Offset.
ImportExportPolicy is define policy relating to the import and export of prefixes from a BGP peer.
ImportExportPolicyAllow is the type definition for a ImportExportPolicyAllow.
ImportExportPolicyNoFiltering is do not perform any filtering.
Instance is view of an Instance
Required fields: - Description - Hostname - Id - Memory - Name - Ncpus - ProjectId - RunState - TimeCreated - TimeModified - TimeRunStateUpdated.
InstanceCreate is create-time parameters for an `Instance`
Required fields: - Description - Hostname - Memory - Name - Ncpus.
InstanceCreateParams is the request parameters for InstanceCreate
Required fields: - Project - Body.
InstanceDeleteParams is the request parameters for InstanceDelete
Required fields: - Instance.
InstanceDiskAttachment is describe the instance's disks at creation time.
InstanceDiskAttachmentAttach is during instance creation, attach this disk
Required fields: - Name - Type.
InstanceDiskAttachmentCreate is during instance creation, create and attach disks
Required fields: - Description - DiskSource - Name - Size - Type.
InstanceDiskAttachParams is the request parameters for InstanceDiskAttach
Required fields: - Instance - Body.
InstanceDiskDetachParams is the request parameters for InstanceDiskDetach
Required fields: - Instance - Body.
InstanceDiskListParams is the request parameters for InstanceDiskList
Required fields: - Instance.
InstanceEphemeralIpAttachParams is the request parameters for InstanceEphemeralIpAttach
Required fields: - Instance - Body.
InstanceEphemeralIpDetachParams is the request parameters for InstanceEphemeralIpDetach
Required fields: - Instance.
InstanceExternalIpListParams is the request parameters for InstanceExternalIpList
Required fields: - Instance.
InstanceListParams is the request parameters for InstanceList
Required fields: - Project.
InstanceNetworkInterface is an `InstanceNetworkInterface` represents a virtual network interface device attached to an instance.
InstanceNetworkInterfaceAttachment is describes an attachment of an `InstanceNetworkInterface` to an `Instance`, at the time the instance is created.
InstanceNetworkInterfaceAttachmentCreate is create one or more `InstanceNetworkInterface`s for the `Instance`.
InstanceNetworkInterfaceAttachmentDefault is the default networking configuration for an instance is to create a single primary interface with an automatically-assigned IP address.
InstanceNetworkInterfaceAttachmentNone is no network interfaces at all will be created for the instance.
InstanceNetworkInterfaceCreate is create-time parameters for an `InstanceNetworkInterface`
Required fields: - Description - Name - SubnetName - VpcName.
InstanceNetworkInterfaceCreateParams is the request parameters for InstanceNetworkInterfaceCreate
Required fields: - Instance - Body.
InstanceNetworkInterfaceDeleteParams is the request parameters for InstanceNetworkInterfaceDelete
Required fields: - Interface.
InstanceNetworkInterfaceListParams is the request parameters for InstanceNetworkInterfaceList
Required fields: - Instance.
InstanceNetworkInterfaceResultsPage is a single page of results
Required fields: - Items.
InstanceNetworkInterfaceUpdate is parameters for updating an `InstanceNetworkInterface`
Note that modifying IP addresses for an interface is not yet supported, a new interface must be created instead.
InstanceNetworkInterfaceUpdateParams is the request parameters for InstanceNetworkInterfaceUpdate
Required fields: - Interface - Body.
InstanceNetworkInterfaceViewParams is the request parameters for InstanceNetworkInterfaceView
Required fields: - Interface.
InstanceRebootParams is the request parameters for InstanceReboot
Required fields: - Instance.
InstanceResultsPage is a single page of results
Required fields: - Items.
InstanceSerialConsoleData is contents of an Instance's serial console buffer.
InstanceSerialConsoleParams is the request parameters for InstanceSerialConsole
Required fields: - Instance.
InstanceSerialConsoleStreamParams is the request parameters for InstanceSerialConsoleStream
Required fields: - Instance.
InstanceSshPublicKeyListParams is the request parameters for InstanceSshPublicKeyList
Required fields: - Instance.
InstanceStartParams is the request parameters for InstanceStart
Required fields: - Instance.
InstanceStopParams is the request parameters for InstanceStop
Required fields: - Instance.
InstanceViewParams is the request parameters for InstanceView
Required fields: - Instance.
IpPool is a collection of IP ranges.
IpPoolCreate is create-time parameters for an `IpPool`
Required fields: - Description - Name.
IpPoolCreateParams is the request parameters for IpPoolCreate
Required fields: - Body.
IpPoolDeleteParams is the request parameters for IpPoolDelete
Required fields: - Pool.
IpPoolLinkSilo is the type definition for a IpPoolLinkSilo.
IpPoolListParams is the request parameters for IpPoolList.
IpPoolRange is the type definition for a IpPoolRange.
IpPoolRangeAddParams is the request parameters for IpPoolRangeAdd
Required fields: - Pool - Body.
IpPoolRangeListParams is the request parameters for IpPoolRangeList
Required fields: - Pool.
IpPoolRangeRemoveParams is the request parameters for IpPoolRangeRemove
Required fields: - Pool - Body.
IpPoolRangeResultsPage is a single page of results
Required fields: - Items.
IpPoolResultsPage is a single page of results
Required fields: - Items.
IpPoolServiceRangeAddParams is the request parameters for IpPoolServiceRangeAdd
Required fields: - Body.
IpPoolServiceRangeListParams is the request parameters for IpPoolServiceRangeList.
IpPoolServiceRangeRemoveParams is the request parameters for IpPoolServiceRangeRemove
Required fields: - Body.
IpPoolSiloLink is a link between an IP pool and a silo that allows one to allocate IPs from the pool within the silo
Required fields: - IpPoolId - IsDefault - SiloId.
IpPoolSiloLinkParams is the request parameters for IpPoolSiloLink
Required fields: - Pool - Body.
IpPoolSiloLinkResultsPage is a single page of results
Required fields: - Items.
IpPoolSiloListParams is the request parameters for IpPoolSiloList
Required fields: - Pool.
IpPoolSiloUnlinkParams is the request parameters for IpPoolSiloUnlink
Required fields: - Pool - Silo.
IpPoolSiloUpdate is the type definition for a IpPoolSiloUpdate.
IpPoolSiloUpdateParams is the request parameters for IpPoolSiloUpdate
Required fields: - Pool - Silo - Body.
IpPoolUpdate is parameters for updating an IP Pool.
IpPoolUpdateParams is the request parameters for IpPoolUpdate
Required fields: - Pool - Body.
IpPoolUtilization is the type definition for a IpPoolUtilization.
IpPoolUtilizationViewParams is the request parameters for IpPoolUtilizationView
Required fields: - Pool.
IpPoolViewParams is the request parameters for IpPoolView
Required fields: - Pool.
Ipv4Range is a non-decreasing IPv4 address range, inclusive of both ends.
Ipv4Utilization is the type definition for a Ipv4Utilization.
Ipv6Range is a non-decreasing IPv6 address range, inclusive of both ends.
Ipv6Utilization is the type definition for a Ipv6Utilization.
LinkConfigCreate is switch link configuration.
LldpLinkConfig is a link layer discovery protocol (LLDP) service configuration.
LldpLinkConfigCreate is the LLDP configuration associated with a port.
LocalIdpUserCreateParams is the request parameters for LocalIdpUserCreate
Required fields: - Silo - Body.
LocalIdpUserDeleteParams is the request parameters for LocalIdpUserDelete
Required fields: - UserId - Silo.
LocalIdpUserSetPasswordParams is the request parameters for LocalIdpUserSetPassword
Required fields: - UserId - Silo - Body.
LoginLocalParams is the request parameters for LoginLocal
Required fields: - SiloName - Body.
LoginSamlParams is the request parameters for LoginSaml
Required fields: - ProviderName - SiloName - Body.
LoopbackAddress is a loopback address is an address that is assigned to a rack switch but is not associated with any particular port.
LoopbackAddressCreate is parameters for creating a loopback address on a particular rack switch.
LoopbackAddressResultsPage is a single page of results
Required fields: - Items.
Measurement is a `Measurement` is a timestamped datum from a single metric
Required fields: - Datum - Timestamp.
MeasurementResultsPage is a single page of results
Required fields: - Items.
MissingDatum is the type definition for a MissingDatum.
NetworkingAddressLotBlockListParams is the request parameters for NetworkingAddressLotBlockList
Required fields: - AddressLot.
NetworkingAddressLotCreateParams is the request parameters for NetworkingAddressLotCreate
Required fields: - Body.
NetworkingAddressLotDeleteParams is the request parameters for NetworkingAddressLotDelete
Required fields: - AddressLot.
NetworkingAddressLotListParams is the request parameters for NetworkingAddressLotList.
NetworkingAllowListUpdateParams is the request parameters for NetworkingAllowListUpdate
Required fields: - Body.
NetworkingBfdDisableParams is the request parameters for NetworkingBfdDisable
Required fields: - Body.
NetworkingBfdEnableParams is the request parameters for NetworkingBfdEnable
Required fields: - Body.
NetworkingBgpAnnouncementListParams is the request parameters for NetworkingBgpAnnouncementList
Required fields: - NameOrId.
NetworkingBgpAnnounceSetDeleteParams is the request parameters for NetworkingBgpAnnounceSetDelete
Required fields: - NameOrId.
NetworkingBgpAnnounceSetListParams is the request parameters for NetworkingBgpAnnounceSetList.
NetworkingBgpAnnounceSetUpdateParams is the request parameters for NetworkingBgpAnnounceSetUpdate
Required fields: - Body.
NetworkingBgpConfigCreateParams is the request parameters for NetworkingBgpConfigCreate
Required fields: - Body.
NetworkingBgpConfigDeleteParams is the request parameters for NetworkingBgpConfigDelete
Required fields: - NameOrId.
NetworkingBgpConfigListParams is the request parameters for NetworkingBgpConfigList.
NetworkingBgpImportedRoutesIpv4Params is the request parameters for NetworkingBgpImportedRoutesIpv4
Required fields: - Asn.
NetworkingBgpMessageHistoryParams is the request parameters for NetworkingBgpMessageHistory
Required fields: - Asn.
NetworkingLoopbackAddressCreateParams is the request parameters for NetworkingLoopbackAddressCreate
Required fields: - Body.
NetworkingLoopbackAddressDeleteParams is the request parameters for NetworkingLoopbackAddressDelete
Required fields: - Address - RackId - SubnetMask - SwitchLocation.
NetworkingLoopbackAddressListParams is the request parameters for NetworkingLoopbackAddressList.
NetworkingSwitchPortApplySettingsParams is the request parameters for NetworkingSwitchPortApplySettings
Required fields: - Port - RackId - SwitchLocation - Body.
NetworkingSwitchPortClearSettingsParams is the request parameters for NetworkingSwitchPortClearSettings
Required fields: - Port - RackId - SwitchLocation.
NetworkingSwitchPortListParams is the request parameters for NetworkingSwitchPortList.
NetworkingSwitchPortSettingsCreateParams is the request parameters for NetworkingSwitchPortSettingsCreate
Required fields: - Body.
NetworkingSwitchPortSettingsDeleteParams is the request parameters for NetworkingSwitchPortSettingsDelete.
NetworkingSwitchPortSettingsListParams is the request parameters for NetworkingSwitchPortSettingsList.
NetworkingSwitchPortSettingsViewParams is the request parameters for NetworkingSwitchPortSettingsView
Required fields: - Port.
NetworkingSwitchPortStatusParams is the request parameters for NetworkingSwitchPortStatus
Required fields: - Port - RackId - SwitchLocation.
NetworkInterface is information required to construct a virtual network interface
Required fields: - Id - Ip - Kind - Mac - Name - Primary - Slot - Subnet - Vni.
NetworkInterfaceKind is the type of network interface.
NetworkInterfaceKindInstance is a vNIC attached to a guest instance
Required fields: - Id - Type.
NetworkInterfaceKindProbe is a vNIC associated with a probe
Required fields: - Id - Type.
NetworkInterfaceKindService is a vNIC associated with an internal service
Required fields: - Id - Type.
OxqlQueryResult is the result of a successful OxQL query.
PhysicalDisk is view of a Physical Disk
Physical disks reside in a particular sled and are used to store both Instance Disk data as well as internal metadata.
PhysicalDiskListParams is the request parameters for PhysicalDiskList.
PhysicalDiskPolicy is the operator-defined policy of a physical disk.
PhysicalDiskPolicyExpunged is the operator has indicated that the disk has been permanently removed from service.
PhysicalDiskPolicyInService is the operator has indicated that the disk is in-service.
PhysicalDiskResultsPage is a single page of results
Required fields: - Items.
PhysicalDiskViewParams is the request parameters for PhysicalDiskView
Required fields: - DiskId.
Ping is the type definition for a Ping.
Points is timepoints and values for one timeseries.
PolicyUpdateParams is the request parameters for PolicyUpdate
Required fields: - Body.
Probe is identity-related metadata that's included in nearly all public API objects
Required fields: - Description - Id - Name - Sled - TimeCreated - TimeModified.
ProbeCreate is create time parameters for probes.
ProbeCreateParams is the request parameters for ProbeCreate
Required fields: - Project - Body.
ProbeDeleteParams is the request parameters for ProbeDelete
Required fields: - Project - Probe.
ProbeExternalIp is the type definition for a ProbeExternalIp.
ProbeInfo is the type definition for a ProbeInfo.
ProbeInfoResultsPage is a single page of results
Required fields: - Items.
ProbeListParams is the request parameters for ProbeList
Required fields: - Project.
ProbeViewParams is the request parameters for ProbeView
Required fields: - Probe - Project.
Project is view of a Project
Required fields: - Description - Id - Name - TimeCreated - TimeModified.
ProjectCreate is create-time parameters for a `Project`
Required fields: - Description - Name.
ProjectCreateParams is the request parameters for ProjectCreate
Required fields: - Body.
ProjectDeleteParams is the request parameters for ProjectDelete
Required fields: - Project.
ProjectIpPoolListParams is the request parameters for ProjectIpPoolList.
ProjectIpPoolViewParams is the request parameters for ProjectIpPoolView
Required fields: - Pool.
ProjectListParams is the request parameters for ProjectList.
ProjectPolicyUpdateParams is the request parameters for ProjectPolicyUpdate
Required fields: - Project - Body.
ProjectPolicyViewParams is the request parameters for ProjectPolicyView
Required fields: - Project.
ProjectResultsPage is a single page of results
Required fields: - Items.
ProjectRolePolicy is policy for a particular resource
Note that the Policy only describes access granted explicitly for this resource.
ProjectRoleRoleAssignment is describes the assignment of a particular role on a particular resource to a particular identity (user, group, etc.)
The resource is not part of this structure.
ProjectUpdate is updateable properties of a `Project`.
ProjectUpdateParams is the request parameters for ProjectUpdate
Required fields: - Project - Body.
ProjectViewParams is the request parameters for ProjectView
Required fields: - Project.
Quantile is structure for estimating the p-quantile of a population.
Rack is view of an Rack
Required fields: - Id - TimeCreated - TimeModified.
RackListParams is the request parameters for RackList.
RackResultsPage is a single page of results
Required fields: - Items.
RackViewParams is the request parameters for RackView
Required fields: - RackId.
Role is view of a Role
Required fields: - Description - Name.
RoleListParams is the request parameters for RoleList.
RoleResultsPage is a single page of results
Required fields: - Items.
RoleViewParams is the request parameters for RoleView
Required fields: - RoleName.
Route is a route to a destination network through a gateway address.
RouteConfig is route configuration data associated with a switch port configuration.
RouteDestination is a `RouteDestination` is used to match traffic with a routing rule, on the destination of that traffic.
RouteDestinationIp is route applies to traffic destined for a specific IP address
Required fields: - Type - Value.
RouteDestinationIpNet is route applies to traffic destined for a specific IP subnet
Required fields: - Type - Value.
RouteDestinationSubnet is route applies to traffic
Required fields: - Type - Value.
RouteDestinationVpc is route applies to traffic destined for the given VPC.
RouterRoute is a route defines a rule that governs where traffic should be sent based on its destination.
RouterRouteCreate is create-time parameters for a `RouterRoute`
Required fields: - Description - Destination - Name - Target.
RouterRouteResultsPage is a single page of results
Required fields: - Items.
RouterRouteUpdate is updateable properties of a `RouterRoute`
Required fields: - Destination - Target.
RouteTarget is a `RouteTarget` describes the possible locations that traffic matching a route destination can be sent.
RouteTargetDrop is drop matching traffic
Required fields: - Type.
RouteTargetInstance is forward traffic to a specific instance
Required fields: - Type - Value.
RouteTargetInternetGateway is forward traffic to an internet gateway
Required fields: - Type - Value.
RouteTargetIp is forward traffic to a particular IP address.
RouteTargetSubnet is forward traffic to a VPC Subnet
Required fields: - Type - Value.
RouteTargetVpc is forward traffic to a VPC
Required fields: - Type - Value.
SamlIdentityProvider is identity-related metadata that's included in nearly all public API objects
Required fields: - AcsUrl - Description - Id - IdpEntityId - Name - SloUrl - SpClientId - TechnicalContactEmail - TimeCreated - TimeModified.
SamlIdentityProviderCreate is create-time identity-related parameters
Required fields: - AcsUrl - Description - IdpEntityId - IdpMetadataSource - Name - SloUrl - SpClientId - TechnicalContactEmail.
SamlIdentityProviderCreateParams is the request parameters for SamlIdentityProviderCreate
Required fields: - Silo - Body.
SamlIdentityProviderViewParams is the request parameters for SamlIdentityProviderView
Required fields: - Provider - Silo.
Silo is view of a Silo
A Silo is the highest level unit of isolation.
SiloCreate is create-time parameters for a `Silo`
Required fields: - Description - Discoverable - IdentityMode - Name - Quotas - TlsCertificates.
SiloCreateParams is the request parameters for SiloCreate
Required fields: - Body.
SiloDeleteParams is the request parameters for SiloDelete
Required fields: - Silo.
SiloIdentityProviderListParams is the request parameters for SiloIdentityProviderList
Required fields: - Silo.
SiloIpPool is an IP pool in the context of a silo
Required fields: - Description - Id - IsDefault - Name - TimeCreated - TimeModified.
SiloIpPoolListParams is the request parameters for SiloIpPoolList
Required fields: - Silo.
SiloIpPoolResultsPage is a single page of results
Required fields: - Items.
SiloListParams is the request parameters for SiloList.
SiloMetricParams is the request parameters for SiloMetric
Required fields: - EndTime - StartTime - MetricName.
SiloPolicyUpdateParams is the request parameters for SiloPolicyUpdate
Required fields: - Silo - Body.
SiloPolicyViewParams is the request parameters for SiloPolicyView
Required fields: - Silo.
SiloQuotas is a collection of resource counts used to set the virtual capacity of a silo
Required fields: - Cpus - Memory - SiloId - Storage.
SiloQuotasCreate is the amount of provisionable resources for a Silo
Required fields: - Cpus - Memory - Storage.
SiloQuotasResultsPage is a single page of results
Required fields: - Items.
SiloQuotasUpdate is updateable properties of a Silo's resource limits.
SiloQuotasUpdateParams is the request parameters for SiloQuotasUpdate
Required fields: - Silo - Body.
SiloQuotasViewParams is the request parameters for SiloQuotasView
Required fields: - Silo.
SiloResultsPage is a single page of results
Required fields: - Items.
SiloRolePolicy is policy for a particular resource
Note that the Policy only describes access granted explicitly for this resource.
SiloRoleRoleAssignment is describes the assignment of a particular role on a particular resource to a particular identity (user, group, etc.)
The resource is not part of this structure.
SiloUserListParams is the request parameters for SiloUserList
Required fields: - Silo.
SiloUserViewParams is the request parameters for SiloUserView
Required fields: - UserId - Silo.
SiloUtilization is view of a silo's resource utilization and capacity
Required fields: - Allocated - Provisioned - SiloId - SiloName.
SiloUtilizationListParams is the request parameters for SiloUtilizationList.
SiloUtilizationResultsPage is a single page of results
Required fields: - Items.
SiloUtilizationViewParams is the request parameters for SiloUtilizationView
Required fields: - Silo.
SiloViewParams is the request parameters for SiloView
Required fields: - Silo.
Sled is an operator's view of a Sled.
SledAddParams is the request parameters for SledAdd
Required fields: - Body.
SledId is the unique ID of a sled.
SledInstance is an operator's view of an instance running on a given sled
Required fields: - ActiveSledId - Id - Memory - Name - Ncpus - ProjectName - SiloName - State - TimeCreated - TimeModified.
SledInstanceListParams is the request parameters for SledInstanceList
Required fields: - SledId.
SledInstanceResultsPage is a single page of results
Required fields: - Items.
SledListParams is the request parameters for SledList.
SledListUninitializedParams is the request parameters for SledListUninitialized.
SledPhysicalDiskListParams is the request parameters for SledPhysicalDiskList
Required fields: - SledId.
SledPolicy is the operator-defined policy of a sled.
SledPolicyExpunged is the operator has indicated that the sled has been permanently removed from service.
SledPolicyInService is the operator has indicated that the sled is in-service.
SledProvisionPolicyParams is parameters for `sled_set_provision_policy`.
SledProvisionPolicyResponse is response to `sled_set_provision_policy`.
SledResultsPage is a single page of results
Required fields: - Items.
SledSetProvisionPolicyParams is the request parameters for SledSetProvisionPolicy
Required fields: - SledId - Body.
SledViewParams is the request parameters for SledView
Required fields: - SledId.
Snapshot is view of a Snapshot
Required fields: - Description - DiskId - Id - Name - ProjectId - Size - State - TimeCreated - TimeModified.
SnapshotCreate is create-time parameters for a `Snapshot`
Required fields: - Description - Disk - Name.
SnapshotCreateParams is the request parameters for SnapshotCreate
Required fields: - Project - Body.
SnapshotDeleteParams is the request parameters for SnapshotDelete
Required fields: - Snapshot.
SnapshotListParams is the request parameters for SnapshotList
Required fields: - Project.
SnapshotResultsPage is a single page of results
Required fields: - Items.
SnapshotViewParams is the request parameters for SnapshotView
Required fields: - Snapshot.
SshKey is view of an SSH Key
Required fields: - Description - Id - Name - PublicKey - SiloUserId - TimeCreated - TimeModified.
SshKeyCreate is create-time parameters for an `SshKey`
Required fields: - Description - Name - PublicKey.
SshKeyResultsPage is a single page of results
Required fields: - Items.
Switch is an operator's view of a Switch.
SwitchBgpHistory is bGP message history for a particular switch.
SwitchInterfaceConfig is a switch port interface configuration for a port settings object.
SwitchInterfaceConfigCreate is a layer-3 switch interface configuration.
SwitchInterfaceKind is indicates the kind for a switch interface.
SwitchInterfaceKindLoopback is loopback interfaces are anchors for IP addresses that are not specific to any particular port.
SwitchInterfaceKindPrimary is primary interfaces are associated with physical links.
SwitchInterfaceKindVlan is vLAN interfaces allow physical interfaces to be multiplexed onto multiple logical links, each distinguished by a 12-bit 802.1Q Ethernet tag.
SwitchListParams is the request parameters for SwitchList.
SwitchPort is a switch port represents a physical external port on a rack switch.
SwitchPortAddressConfig is an IP address configuration for a port settings object.
SwitchPortApplySettings is parameters for applying settings to switch ports.
SwitchPortConfig is a physical port configuration for a port settings object.
SwitchPortConfigCreate is physical switch port configuration.
SwitchPortLinkConfig is a link configuration for a port settings object.
SwitchPortResultsPage is a single page of results
Required fields: - Items.
SwitchPortRouteConfig is a route configuration for a port settings object.
SwitchPortSettings is a switch port settings identity whose id may be used to view additional details.
SwitchPortSettingsCreate is parameters for creating switch port settings.
SwitchPortSettingsGroups is this structure maps a port settings object to a port settings groups.
SwitchPortSettingsResultsPage is a single page of results
Required fields: - Items.
SwitchPortSettingsView is this structure contains all port settings information in one place.
SwitchResultsPage is a single page of results
Required fields: - Items.
SwitchViewParams is the request parameters for SwitchView
Required fields: - SwitchId.
SwitchVlanInterfaceConfig is a switch port VLAN interface configuration for a port settings object.
SystemMetricParams is the request parameters for SystemMetric
Required fields: - EndTime - StartTime - MetricName.
SystemPolicyUpdateParams is the request parameters for SystemPolicyUpdate
Required fields: - Body.
SystemQuotasListParams is the request parameters for SystemQuotasList.
Table is a table represents one or more timeseries with the same schema.
Timeseries is a timeseries contains a timestamped set of values from one source.
TimeseriesDescription is text descriptions for the target and metric of a timeseries.
TimeseriesQuery is a timeseries query string, written in the Oximeter query language.
TimeseriesQueryParams is the request parameters for TimeseriesQuery
Required fields: - Body.
TimeseriesSchema is the schema for a timeseries.
TimeseriesSchemaListParams is the request parameters for TimeseriesSchemaList.
TimeseriesSchemaResultsPage is a single page of results
Required fields: - Items.
UninitializedSled is a sled that has not been added to an initialized rack yet
Required fields: - Baseboard - Cubby - RackId.
UninitializedSledId is the unique hardware ID for a sled
Required fields: - Part - Serial.
UninitializedSledResultsPage is a single page of results
Required fields: - Items.
User is view of a User
Required fields: - DisplayName - Id - SiloId.
UserBuiltin is view of a Built-in User
# Built-in users are identities internal to the system, used when the control plane performs actions autonomously
Required fields: - Description - Id - Name - TimeCreated - TimeModified.
UserBuiltinListParams is the request parameters for UserBuiltinList.
UserBuiltinResultsPage is a single page of results
Required fields: - Items.
UserBuiltinViewParams is the request parameters for UserBuiltinView
Required fields: - User.
UserCreate is create-time parameters for a `User`
Required fields: - ExternalId - Password.
UserListParams is the request parameters for UserList.
UsernamePasswordCredentials is credentials for local user login
Required fields: - Password - Username.
UserPassword is parameters for setting a user's password.
UserPasswordLoginDisallowed is invalidates any current password (disabling password authentication)
Required fields: - Mode.
UserPasswordPassword is sets the user's password to the provided value
Required fields: - Mode - Value.
UserResultsPage is a single page of results
Required fields: - Items.
Utilization is view of the current silo's resource utilization and capacity
Required fields: - Capacity - Provisioned.
Validator is a helper to validate the Client methods.
ValueArray is list of data values for one timeseries.
ValueArrayBoolean is the type definition for a ValueArrayBoolean.
ValueArrayDouble is the type definition for a ValueArrayDouble.
ValueArrayDoubleDistribution is the type definition for a ValueArrayDoubleDistribution.
ValueArrayInteger is the type definition for a ValueArrayInteger.
ValueArrayIntegerDistribution is the type definition for a ValueArrayIntegerDistribution.
ValueArrayString is the type definition for a ValueArrayString.
Values is a single list of values, for one dimension of a timeseries.
VirtualResourceCounts is a collection of resource counts used to describe capacity and utilization
Required fields: - Cpus - Memory - Storage.
Vpc is view of a VPC
Required fields: - Description - DnsName - Id - Ipv6Prefix - Name - ProjectId - SystemRouterId - TimeCreated - TimeModified.
VpcCreate is create-time parameters for a `Vpc`
Required fields: - Description - DnsName - Name.
VpcCreateParams is the request parameters for VpcCreate
Required fields: - Project - Body.
VpcDeleteParams is the request parameters for VpcDelete
Required fields: - Vpc.
VpcFirewallRule is a single rule in a VPC firewall
Required fields: - Action - Description - Direction - Filters - Id - Name - Priority - Status - Targets - TimeCreated - TimeModified - VpcId.
VpcFirewallRuleFilter is filters reduce the scope of a firewall rule.
VpcFirewallRuleHostFilter is the `VpcFirewallRuleHostFilter` is used to filter traffic on the basis of its source or destination host.
VpcFirewallRuleHostFilterInstance is the rule applies to traffic from/to this specific instance
Required fields: - Type - Value.
VpcFirewallRuleHostFilterIp is the rule applies to traffic from/to a specific IP address
Required fields: - Type - Value.
VpcFirewallRuleHostFilterIpNet is the rule applies to traffic from/to a specific IP subnet
Required fields: - Type - Value.
VpcFirewallRuleHostFilterSubnet is the rule applies to traffic from/to all instances in the VPC Subnet
Required fields: - Type - Value.
VpcFirewallRuleHostFilterVpc is the rule applies to traffic from/to all instances in the VPC
Required fields: - Type - Value.
VpcFirewallRules is collection of a Vpc's firewall rules
Required fields: - Rules.
VpcFirewallRulesUpdateParams is the request parameters for VpcFirewallRulesUpdate
Required fields: - Vpc - Body.
VpcFirewallRulesViewParams is the request parameters for VpcFirewallRulesView
Required fields: - Vpc.
VpcFirewallRuleTarget is a `VpcFirewallRuleTarget` is used to specify the set of instances to which a firewall rule applies.
VpcFirewallRuleTargetInstance is the rule applies to this specific instance
Required fields: - Type - Value.
VpcFirewallRuleTargetIp is the rule applies to a specific IP address
Required fields: - Type - Value.
VpcFirewallRuleTargetIpNet is the rule applies to a specific IP subnet
Required fields: - Type - Value.
VpcFirewallRuleTargetSubnet is the rule applies to all instances in the VPC Subnet
Required fields: - Type - Value.
VpcFirewallRuleTargetVpc is the rule applies to all instances in the VPC
Required fields: - Type - Value.
VpcFirewallRuleUpdate is a single rule in a VPC firewall
Required fields: - Action - Description - Direction - Filters - Name - Priority - Status - Targets.
VpcFirewallRuleUpdateParams is updated list of firewall rules.
VpcListParams is the request parameters for VpcList
Required fields: - Project.
VpcResultsPage is a single page of results
Required fields: - Items.
VpcRouter is a VPC router defines a series of rules that indicate where traffic should be sent depending on its destination.
VpcRouterCreate is create-time parameters for a `VpcRouter`
Required fields: - Description - Name.
VpcRouterCreateParams is the request parameters for VpcRouterCreate
Required fields: - Vpc - Body.
VpcRouterDeleteParams is the request parameters for VpcRouterDelete
Required fields: - Router.
VpcRouterListParams is the request parameters for VpcRouterList
Required fields: - Vpc.
VpcRouterResultsPage is a single page of results
Required fields: - Items.
VpcRouterRouteCreateParams is the request parameters for VpcRouterRouteCreate
Required fields: - Router - Body.
VpcRouterRouteDeleteParams is the request parameters for VpcRouterRouteDelete
Required fields: - Route.
VpcRouterRouteListParams is the request parameters for VpcRouterRouteList
Required fields: - Router.
VpcRouterRouteUpdateParams is the request parameters for VpcRouterRouteUpdate
Required fields: - Route - Body.
VpcRouterRouteViewParams is the request parameters for VpcRouterRouteView
Required fields: - Route - Router.
VpcRouterUpdate is updateable properties of a `VpcRouter`.
VpcRouterUpdateParams is the request parameters for VpcRouterUpdate
Required fields: - Router - Body.
VpcRouterViewParams is the request parameters for VpcRouterView
Required fields: - Router.
VpcSubnet is a VPC subnet represents a logical grouping for instances that allows network traffic between them, within a IPv4 subnetwork or optionally an IPv6 subnetwork.
VpcSubnetCreate is create-time parameters for a `VpcSubnet`
Required fields: - Description - Ipv4Block - Name.
VpcSubnetCreateParams is the request parameters for VpcSubnetCreate
Required fields: - Vpc - Body.
VpcSubnetDeleteParams is the request parameters for VpcSubnetDelete
Required fields: - Subnet.
VpcSubnetListNetworkInterfacesParams is the request parameters for VpcSubnetListNetworkInterfaces
Required fields: - Subnet.
VpcSubnetListParams is the request parameters for VpcSubnetList
Required fields: - Vpc.
VpcSubnetResultsPage is a single page of results
Required fields: - Items.
VpcSubnetUpdate is updateable properties of a `VpcSubnet`.
VpcSubnetUpdateParams is the request parameters for VpcSubnetUpdate
Required fields: - Subnet - Body.
VpcSubnetViewParams is the request parameters for VpcSubnetView
Required fields: - Subnet.
VpcUpdate is updateable properties of a `Vpc`.
VpcUpdateParams is the request parameters for VpcUpdate
Required fields: - Vpc - Body.
VpcViewParams is the request parameters for VpcView
Required fields: - Vpc.
# Type aliases
AddressLotKind is infrastructure address lots are used for network infrastructure like addresses assigned to rack switches.
AllowedSourceIpsAllow is the type definition for a AllowedSourceIpsAllow.
AuthzScope is timeseries data is limited to fleet readers.
BfdMode is bFD connection mode.
BfdState is a stable down state.
BgpMessageHistory is the type definition for a BgpMessageHistory.
BgpPeerState is initial state.
BinRangedoubleType is the type definition for a BinRangedoubleType.
BinRangefloatType is the type definition for a BinRangefloatType.
BinRangeint16Type is the type definition for a BinRangeint16Type.
BinRangeint32Type is the type definition for a BinRangeint32Type.
BinRangeint64Type is the type definition for a BinRangeint64Type.
BinRangeint8Type is the type definition for a BinRangeint8Type.
BinRangeuint16Type is the type definition for a BinRangeuint16Type.
BinRangeuint32Type is the type definition for a BinRangeuint32Type.
BinRangeuint64Type is the type definition for a BinRangeuint64Type.
BinRangeuint8Type is the type definition for a BinRangeuint8Type.
BlockSize is the type definition for a BlockSize.
ByteCount is byte count to express memory or storage capacity.
DatumType is the type definition for a DatumType.
DigestType is the type definition for a DigestType.
DiskMetricName is the type definition for a DiskMetricName.
DiskSourceType is the type definition for a DiskSourceType.
DiskStateState is the type definition for a DiskStateState.
ErrorResponse is the response given when error.
ExternalIpCreateType is the type definition for a ExternalIpCreateType.
ExternalIpKind is the type definition for a ExternalIpKind.
FieldSource is the source from which a field is derived, the target or metric.
FieldType is the `FieldType` identifies the data type of a target or metric field.
FieldValueType is the type definition for a FieldValueType.
FleetRole is the type definition for a FleetRole.
FloatingIpParentKind is the type of resource that a floating IP is attached to.
Hostname is a hostname identifies a host on a network, and is usually a dot-delimited sequence of labels, where each label contains only letters, digits, or the hyphen.
IdentityProviderType is sAML identity provider.
IdentityType is describes what kind of identity is described by an id.
IdpMetadataSourceType is the type definition for a IdpMetadataSourceType.
IdSortMode is sort in increasing order of "id".
ImageSourceType is the type definition for a ImageSourceType.
ImportExportPolicyType is the type definition for a ImportExportPolicyType.
InstanceCpuCount is the number of CPUs in an Instance.
InstanceDiskAttachmentType is the type definition for a InstanceDiskAttachmentType.
InstanceNetworkInterfaceAttachmentType is the type definition for a InstanceNetworkInterfaceAttachmentType.
InstanceState is the instance is being created.
Ipv4Net is an IPv4 subnet, including prefix and prefix length.
Ipv6Net is an IPv6 subnet, including prefix and subnet mask.
L4PortRange is an inclusive-inclusive range of IP ports.
LinkFec is firecode forward error correction.
LinkSpeed is zero gigabits per second.
MacAddr is a Media Access Control address, in EUI-48 format.
MetricType is the value represents an instantaneous measurement in time.
Name is names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'.
NameOrId is the type definition for a NameOrId.
NameOrIdSortMode is sort in increasing order of "name".
NameSortMode is sort in increasing order of "name".
NetworkInterfaceKindType is the type definition for a NetworkInterfaceKindType.
PaginationOrder is the order in which the client wants to page through the requested collection.
Password is passwords may be subject to additional constraints.
PhysicalDiskKind is describes the form factor of physical disks.
PhysicalDiskPolicyKind is the type definition for a PhysicalDiskPolicyKind.
PhysicalDiskState is the disk is currently active, and has resources allocated on it.
PingStatus is the type definition for a PingStatus.
ProbeExternalIpKind is the type definition for a ProbeExternalIpKind.
ProjectRole is the type definition for a ProjectRole.
RoleName is role names consist of two string components separated by dot (".").
RouteDestinationType is the type definition for a RouteDestinationType.
RouterRouteKind is determines the default destination of traffic, such as whether it goes to the internet or not.
RouteTargetType is the type definition for a RouteTargetType.
ServiceUsingCertificate is this certificate is intended for access to the external API.
SiloIdentityMode is users are authenticated with SAML using an external authentication provider.
SiloRole is the type definition for a SiloRole.
SledPolicyKind is the type definition for a SledPolicyKind.
SledProvisionPolicy is new resources will be provisioned on this sled.
SledState is the sled is currently active, and has resources allocated on it.
SnapshotState is the type definition for a SnapshotState.
SwitchInterfaceKind2 is primary interfaces are associated with physical links.
SwitchInterfaceKindType is the type definition for a SwitchInterfaceKindType.
SwitchLinkState is the type definition for a SwitchLinkState.
SwitchLocation is switch in upper slot.
SwitchPortGeometry is the port contains a single QSFP28 link with four lanes.
SwitchPortGeometry2 is the port contains a single QSFP28 link with four lanes.
SystemMetricName is the type definition for a SystemMetricName.
TimeseriesName is names are constructed by concatenating the target and metric names with ':'.
Units is the type definition for a Units.
UserId is usernames must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'.
UserPasswordMode is the type definition for a UserPasswordMode.
ValueArrayType is the type definition for a ValueArrayType.
Vni is a Geneve Virtual Network Identifier.
VpcFirewallRuleAction is the type definition for a VpcFirewallRuleAction.
VpcFirewallRuleDirection is the type definition for a VpcFirewallRuleDirection.
VpcFirewallRuleHostFilterType is the type definition for a VpcFirewallRuleHostFilterType.
VpcFirewallRuleProtocol is the protocols that may be specified in a firewall rule's filter.
VpcFirewallRuleStatus is the type definition for a VpcFirewallRuleStatus.
VpcFirewallRuleTargetType is the type definition for a VpcFirewallRuleTargetType.
VpcRouterKind is the type definition for a VpcRouterKind.