model

type APIAllocation struct {
	// ID is the ID of the allocation
	ID string `json:"id"`
	// Name is the name of the Allocation
	Name string `json:"name"`
	// Description is the description of the Allocation
	Description *string `json:"description"`
	// InfrastructureProviderID is the ID of the Infrastructure Provider
	InfrastructureProviderID string `json:"infrastructureProviderId"`
	// InfrastructureProvider is the summary of the Infrastructure Provider
	InfrastructureProvider *APIInfrastructureProviderSummary `json:"infrastructureProvider,omitempty"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// Tenant is the summary of the Tenant
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// Status is the status of the Allocation
	Status string `json:"status"`
	// StatusHistory is the history of statuses for the Allocation
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// CreatedAt indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// UpdatedAt indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
	// AllocationConstraints is a list of Allocation Constraints for the Allocation
	AllocationConstraints []APIAllocationConstraint `json:"allocationConstraints"`
}

type APIAllocationConstraint struct {
	// ID is the unique UUID identified for the Allocation Constraint
	ID string `json:"id"`
	// AllocationID is the ID of the Allocation corresponding to the Allocation Constraint
	AllocationID string `json:"allocationId"`
	// ResourceType is the type of the Resource
	ResourceType string `json:"resourceType"`
	// ResourceTypeID is the ID of the resource corresponding to the Allocation Constraint
	ResourceTypeID string `bun:"resource_type_id,type:uuid,notnull"`
	// ConstraintType is the type of the Allocation Constraint
	ConstraintType string `json:"constraintType"`
	// ConstraintValue is the value of the Allocation Constraint
	ConstraintValue int `json:"constraintValue"`
	// DerivedResourceID is the ID of the derived resource
	DerivedResourceID *string `json:"derivedResourceId"`
	// InstanceType is the summary of the InstaceType
	InstanceType *APIInstanceTypeSummary `json:"instanceType,omitempty"`
	// IPBlock is the summary of the IPBlock
	IPBlock *APIIPBlockSummary `json:"ipBlock,omitempty"`
	// CreatedAt indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// UpdatedAt indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIAllocationConstraintCreateRequest struct {
	// ResourceType is the type of the resource for the Allocation Constraint
	ResourceType string `json:"resourceType"`
	// ResourceTypeID is the ID of the Resource Type
	ResourceTypeID string `json:"resourceTypeId"`
	// ConstraintType is the type of the Allocation Constraint
	ConstraintType string `json:"constraintType"`
	// ConstraintValue is the value of the Allocation Constraint
	ConstraintValue int `json:"constraintValue"`
}

type APIAllocationConstraintUpdateRequest struct {
	// ConstraintValue is the value of the Allocation Constraint
	ConstraintValue int `json:"constraintValue"`
}

type APIAllocationCreateRequest struct {
	// Name is the name of the Allocation
	Name string `json:"name"`
	// Description is the description of the Allocation
	Description *string `json:"description"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// AllocationConstraints is a list of Allocation Constraint objects
	AllocationConstraints []APIAllocationConstraintCreateRequest `json:"allocationConstraints"`
}

type APIAllocationStats struct {
	// Assigned is the total number of Machines assigned to this Instance Type
	Assigned int `json:"assigned"`
	// Total is the total number of Machines allocated to different Tenants for this Instance Type
	Total int `json:"total"`
	// Used is the total number of allocated Machines of this Instance Type currently being used by Tenants
	Used int `json:"used"`
	// Unused is the total number of allocated Machines of this Instance Type that is currently not being used by Tenants
	Unused int `json:"unused"`
	// UnusedUsable is the total number of allocated Machines of this Instance Type that is currently not in use
	// but in Ready state, therefore can be provisioned by Tenant
	UnusedUsable int `json:"unusedUsable"`
	// MaxAllocatable is the maximum number of Machines of this Instance Type that can be allocated to a Tenant
	MaxAllocatable *int `json:"maxAllocatable,omitempty"`
}

type APIAllocationUpdateRequest struct {
	// Name is the name of the Allocation
	Name *string `json:"name"`
	// Description is the description of the Allocation
	Description *string `json:"description"`
}

type APIAuditEntry struct {
	ID            string                 `json:"id"`
	Endpoint      string                 `json:"endpoint"`
	QueryParams   url.Values             `json:"queryParams"`
	Method        string                 `json:"method"`
	Body          map[string]interface{} `json:"body"`
	StatusCode    int                    `json:"statusCode"`
	StatusMessage string                 `json:"statusMessage"`
	ClientIP      string                 `json:"clientIP"`
	UserID        *string                `json:"userID"`
	User          *APIUser               `json:"user"`
	OrgName       string                 `json:"orgName"`
	ExtraData     map[string]interface{} `json:"extraData"`
	Timestamp     time.Time              `json:"timestamp"`
	DurationMs    int64                  `json:"durationMs"`
	APIVersion    string                 `json:"apiVersion"`
}

type APIBMC struct {
	Type       string `json:"type"`
	MacAddress string `json:"macAddress"`
	IPAddress  string `json:"ipAddress"`
}

type APIBMCInfo struct {
	// IP is the IP Address of the Machine's BMI
	IP *string `json:"ip"`
	// Mac is the Mac Address of the Machine's BMI
	Mac *string `json:"mac"`
	// Version is the version of the Machine's BMI
	Version *string `json:"version"`
	// firmwareRevision is the firmare version revision of the Machine's BMI
	FirmwareRevision *string `json:"firmwareRevision"`
}

type APIBatchBringUpRackRequest struct {
	SiteID      string      `json:"siteId"`
	Filter      *RackFilter `json:"filter,omitempty"`
	Description string      `json:"description,omitempty"`
}

type APIBatchInstanceCreateRequest struct {
	// NamePrefix is the prefix for instance names (e.g., "worker" will create "worker-1", "worker-2",
	// etc.)
	NamePrefix string `json:"namePrefix"`
	// Count is the number of instances to create
	Count int `json:"count"`
	// Description is the description for all instances
	Description *string `json:"description"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// InstanceTypeID is the ID of the Instance Type
	InstanceTypeID string `json:"instanceTypeId"`
	// VpcID is the ID of the VPC containing the Instances
	VpcID string `json:"vpcId"`
	// SecondaryVpcIDs lists additional VPC UUIDs for prefix-backed, non-primary
	// network interfaces on each Instance in the batch. Validate() rejects this
	// field unless every entry in Interfaces uses vpcPrefixId, and batch create
	// processing expects these UUIDs to align with the VPCs implied by those
	// prefix-backed interfaces.
	SecondaryVpcIDs []string `json:"secondaryVpcIds"`
	// OperatingSystemID is the ID of the Operating System
	OperatingSystemID *string `json:"operatingSystemId"`
	// IpxeScript is the iPXE script for the Operating System
	IpxeScript *string `json:"ipxeScript"`
	// AlwaysBootWithCustomIpxe is the flag to allow always boot with ipxe
	AlwaysBootWithCustomIpxe *bool `json:"alwaysBootWithCustomIpxe"`
	// PhoneHomeEnabled is the flag to allow enable phone home for the instance
	PhoneHomeEnabled *bool `json:"phoneHomeEnabled"`
	// UserData is the user data for the instances
	UserData *string `json:"userData"`
	// Interfaces is the list of Interfaces to create for each instance (shared across all instances)
	Interfaces []APIInterfaceCreateOrUpdateRequest `json:"interfaces"`
	// InfiniBandInterfaces is the list of InfiniBandInterface to create for each instance (shared across all instances)
	InfiniBandInterfaces []APIInfiniBandInterfaceCreateOrUpdateRequest `json:"infinibandInterfaces"`
	// NVLinkInterfaces is the list of NVLinkInterface to create for each instance (shared across all instances)
	NVLinkInterfaces []APINVLinkInterfaceCreateOrUpdateRequest `json:"nvLinkInterfaces"`
	// DpuExtensionServiceDeployments is the list of DpuExtensionServiceDeployments to create for each Instance (shared across all instances)
	DpuExtensionServiceDeployments []APIDpuExtensionServiceDeploymentRequest `json:"dpuExtensionServiceDeployments"`
	// SSHKeyGroupIDs is a list of SSHKeyGroup IDs (shared across all instances)
	SSHKeyGroupIDs []string `json:"sshKeyGroupIds"`
	// Labels is a key value objects to be applied to all instances (shared across all instances)
	Labels map[string]string `json:"labels"`
	// NetworkSecurityGroupID is the ID of a desired NSG to attach to all instances (shared across all instances)
	NetworkSecurityGroupID *string `json:"networkSecurityGroupId"`
	// TopologyOptimized indicates whether to enforce rack-aware placement
	// If true, all instances must be allocated on machines within the same rack or the request will fail
	TopologyOptimized *bool `json:"topologyOptimized"`
}

type APIBatchRackFirmwareUpdateRequest struct {
	SiteID  string      `json:"siteId"`
	Filter  *RackFilter `json:"filter,omitempty"`
	Version *string     `json:"version,omitempty"`
}

type APIBatchTrayFirmwareUpdateRequest struct {
	SiteID  string      `json:"siteId"`
	Filter  *TrayFilter `json:"filter,omitempty"`
	Version *string     `json:"version,omitempty"`
}

type APIBatchUpdateRackPowerStateRequest struct {
	SiteID string      `json:"siteId"`
	Filter *RackFilter `json:"filter,omitempty"`
	State  string      `json:"state"`
}

type APIBatchUpdateTrayPowerStateRequest struct {
	SiteID string      `json:"siteId"`
	Filter *TrayFilter `json:"filter,omitempty"`
	State  string      `json:"state"`
}

type APIBringUpRackRequest struct {
	SiteID      string `json:"siteId"`
	Description string `json:"description,omitempty"`
}

type APIBringUpRackResponse struct {
	TaskIDs []string `json:"taskIds"`
}

type APIComponentDiff struct {
	Type        string            `json:"type"`
	ID          string            `json:"id,omitempty"`          // RLA internal component UUID
	ComponentID string            `json:"componentId,omitempty"` // Component ID from the component manager service
	Expected    *APIRackComponent `json:"expected,omitempty"`
	Actual      *APIRackComponent `json:"actual,omitempty"`
	FieldDiffs  []*APIFieldDiff   `json:"fieldDiffs,omitempty"`
}

type APIDMIData struct {
	// BoardName is the name of the Machine's board
	BoardName *string `json:"boardName"`
	// BoardVersion is the version of the Machine's board
	BoardVersion *string `json:"boardVersion"`
	// BiosDate is the date of the Machine's bios
	BiosDate *string `json:"biosDate"`
	// BiosVersion is the version of the Machine's bios
	BiosVersion *string `json:"biosVersion"`
	// ProductName is the name of the Machine's product
	ProductName *string `json:"productName"`
	// ProductSerial is searial number the Machine
	ProductSerial *string `json:"productSerial"`
	// BoardSerial is the searial number of the Machine's board
	BoardSerial *string `json:"boardSerial"`
	// ChassisSerial is searial number the Machine's Chassis
	ChassisSerial *string `json:"chassisSerial"`
	// SysVendor is the vendor of the Machine's system
	SysVendor *string `json:"sysVendor"`
}

type APIDeprecation struct {
	// Field denotes the field that is deprecated (optional)
	Attribute *string `json:"attribute,omitempty"`
	// Field denotes the field that is deprecated (optional)
	QueryParam *string `json:"queryparam,omitempty"`
	// Endpoint denotes the endpoint that is deprecated (optional)
	Endpoint *string `json:"endpoint,omitempty"`
	// ReplacedBy denotes the field that replaces the deprecated field (optional)
	ReplacedBy *string `json:"replacedby"`
	// Effective indicates the ISO datetime string for when the deprecation takes effect
	TakeActionBy time.Time `json:"effective"`
	// Notice describes the deprecated field
	Notice string `json:"notice"`
}

type APIDpuExtensionService struct {
	// ID is the unique UUID v4 identifier for the DpuExtensionService
	ID string `json:"id"`
	// Name is the name of the DpuExtensionService
	Name string `json:"name"`
	// Description is the description of the DpuExtensionService
	Description *string `json:"description"`
	// ServiceType is the type of service
	ServiceType string `json:"serviceType"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the site
	Site *APISiteSummary `json:"site,omitempty"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// Tenant is the summary of the tenant
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// Version is the latest version of the DPU Extension Service
	Version *string `json:"version"`
	// VersionInfo holds the details for the latest version
	VersionInfo *APIDpuExtensionServiceVersionInfo `json:"versionInfo"`
	// ActiveVersions is a list of active versions available for deployment
	ActiveVersions []string `json:"activeVersions"`
	// Status is the status of the DpuExtensionService
	Status string `json:"status"`
	// StatusHistory is the status detail records for the DpuExtensionService over time
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// Created indicates the ISO datetime string for when the DpuExtensionService was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the DpuExtensionService was last updated
	Updated time.Time `json:"updated"`
}

type APIDpuExtensionServiceCreateRequest struct {
	// Name is the name of the DpuExtensionService
	Name string `json:"name"`
	// Description is the description of the DpuExtensionService
	Description *string `json:"description"`
	// ServiceType is the type of service
	ServiceType string `json:"serviceType"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Data is the deployment spec for the DPU Extension Service
	Data string `json:"data"`
	// Credentials are the credentials to download resources
	Credentials *APIDpuExtensionServiceCredentials `json:"credentials"`
	// Observability is the observability configuration for the DPU Extension Service version
	Observability *APIDpuExtensionServiceObservability `json:"observability"`
}

type APIDpuExtensionServiceCredentials struct {
	// RegistryURL is the URL for the registry
	RegistryURL string `json:"registryUrl"`
	// Username for the registry
	Username *string `json:"username"`
	// Password for the registry
	Password *string `json:"password"`
}

type APIDpuExtensionServiceDeployment struct {
	// ID is the unique UUID v4 identifier for the DpuExtensionServiceDeployment
	ID string `json:"id"`
	// DpuExtensionService is the summary of the DPU Extension Service
	DpuExtensionService *APIDpuExtensionServiceSummary `json:"dpuExtensionService"`
	// Version is the deployed version of the DPU Extension Service
	Version string `json:"version"`
	// Status is the deployment status
	Status string `json:"status"`
	// Created indicates when this deployment was created
	Created time.Time `json:"created"`
	// Updated indicates when this deployment was last updated
	Updated time.Time `json:"updated"`
}

type APIDpuExtensionServiceDeploymentRequest struct {
	// DpuExtensionServiceID is the ID of the DPU Extension Service to deploy
	DpuExtensionServiceID string `json:"dpuExtensionServiceId"`
	// Version is the version of the DPU Extension Service to deploy
	Version string `json:"version"`
}

type APIDpuExtensionServiceObservability struct {
	// Configs are the observability configurations for the service version
	Configs []APIDpuExtensionServiceObservabilityConfig `json:"configs"`
}

type APIDpuExtensionServiceObservabilityConfig struct {
	// Name is the name of the service or service component being monitored
	Name *string `json:"name"`
	// Prometheus holds prometheus scrape configuration
	Prometheus *APIDpuExtensionServiceObservabilityConfigPrometheus `json:"prometheus,omitempty"`
	// Logging holds logging configuration
	Logging *APIDpuExtensionServiceObservabilityConfigLogging `json:"logging,omitempty"`
}

type APIDpuExtensionServiceObservabilityConfigLogging struct {
	// Path is the log path to collect
	Path string `json:"path"`
}

type APIDpuExtensionServiceObservabilityConfigPrometheus struct {
	// ScrapeIntervalSeconds is how often prometheus should scrape the endpoint
	ScrapeIntervalSeconds uint32 `json:"scrapeIntervalSeconds"`
	// Endpoint is the prometheus scrape endpoint
	Endpoint string `json:"endpoint"`
}

type APIDpuExtensionServiceSummary struct {
	// ID is the unique UUID v4 identifier for the DpuExtensionService
	ID string `json:"id"`
	// Name is the name of the DpuExtensionService
	Name string `json:"name"`
	// ServiceType is the type of service
	ServiceType string `json:"serviceType"`
	// LatestVersion is the latest version of the DPU Extension Service
	LatestVersion *string `json:"latestVersion"`
	// Status is the status of the DpuExtensionService
	Status string `json:"status"`
}

type APIDpuExtensionServiceUpdateRequest struct {
	// Name is the name of the DpuExtensionService
	Name *string `json:"name"`
	// Description is the description of the DpuExtensionService
	Description *string `json:"description"`
	// Data is the deployment spec for the DPU Extension Service
	Data *string `json:"data"`
	// Credentials are the credentials to download resources
	Credentials *APIDpuExtensionServiceCredentials `json:"credentials"`
	// Observability is the observability configuration for the DPU Extension Service version
	Observability *APIDpuExtensionServiceObservability `json:"observability"`
}

type APIDpuExtensionServiceVersionInfo struct {
	// Version is the version identifier
	Version string `json:"version"`
	// Data is the deployment spec
	Data string `json:"data"`
	// HasCredentials indicates if this version has credentials
	HasCredentials bool `json:"hasCredentials"`
	// Created indicates when this version was created
	Created time.Time `json:"created"`
	// Observability is the observability configuration for this version
	Observability *APIDpuExtensionServiceObservability `json:"observability"`
}

type APIExpectedMachine struct {
	// ID is the ID of this Expected Machine
	ID uuid.UUID `json:"id"`
	// BmcMacAddress is the MAC address of the expected machine's BMC
	BmcMacAddress string `json:"bmcMacAddress"`
	// SiteID is the ID of the site this machine belongs to
	SiteID uuid.UUID `json:"siteId"`
	// Site is the site information
	Site *APISite `json:"site,omitempty"`
	// ChassisSerialNumber is the serial number of the expected machine's chassis
	ChassisSerialNumber string `json:"chassisSerialNumber"`
	// FallbackDPUSerialNumbers is the serial numbers of the expected machine's fallback DPUs
	FallbackDPUSerialNumbers []string `json:"fallbackDPUSerialNumbers"`
	// SkuID is the ID of the SKU
	SkuID *string `json:"skuId"`
	// Sku is the SKU information
	Sku *APISku `json:"sku,omitempty"`
	// MachineID is the ID of the Machine associated with this Expected Machine
	MachineID *string `json:"machineId"`
	// Machine is the optional Machine information associated with this Expected Machine
	Machine *APIMachineSummary `json:"machine,omitempty"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected machine
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected machine
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected machine
	Model *string `json:"model"`
	// Description is the optional description of the expected machine
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected machine
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected machine
	Labels map[string]string `json:"labels"`
	// Created indicates the ISO datetime string for when the ExpectedMachine was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the ExpectedMachine was last updated
	Updated time.Time `json:"updated"`
}

type APIExpectedMachineCreateRequest struct {
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// BmcMacAddress is the MAC address of the expected machine's BMC
	BmcMacAddress string `json:"bmcMacAddress"`
	// BmcUsername is the username of the expected machine's BMC
	DefaultBmcUsername *string `json:"defaultBmcUsername"`
	// DefaultBmcPassword is the password of the expected machine's BMC
	DefaultBmcPassword *string `json:"defaultBmcPassword"`
	// ChassisSerialNumber is the serial number of the expected machine's chassis
	ChassisSerialNumber string `json:"chassisSerialNumber"`
	// FallbackDPUSerialNumbers is the serial numbers of the expected machine's fallback DPUs
	FallbackDPUSerialNumbers []string `json:"fallbackDPUSerialNumbers"`
	// SkuId is the optional UUID for an SKU
	SkuID *string `json:"skuId"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected machine
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected machine
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected machine
	Model *string `json:"model"`
	// Description is the optional description of the expected machine
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected machine
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected machine
	Labels map[string]string `json:"labels"`
}

type APIExpectedMachineUpdateRequest struct {
	// ID is required for batch updates (must be empty or match path value for single update)
	ID *string `json:"id"`
	// BmcMacAddress is the MAC address of the expected machine's BMC
	BmcMacAddress *string `json:"bmcMacAddress"`
	// BmcUsername is the username of the expected machine's BMC
	DefaultBmcUsername *string `json:"defaultBmcUsername"`
	// DefaultBmcPassword is the password of the expected machine's BMC
	DefaultBmcPassword *string `json:"defaultBmcPassword"`
	// ChassisSerialNumber is the serial number of the expected machine's chassis
	ChassisSerialNumber *string `json:"chassisSerialNumber"`
	// FallbackDPUSerialNumbers is the serial numbers of the expected machine's fallback DPUs
	FallbackDPUSerialNumbers []string `json:"fallbackDPUSerialNumbers"`
	// SkuId is the optional UUID for an SKU
	SkuID *string `json:"skuId"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected machine
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected machine
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected machine
	Model *string `json:"model"`
	// Description is the optional description of the expected machine
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected machine
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected machine
	Labels map[string]string `json:"labels"`
}

type APIExpectedPowerShelf struct {
	// ID is the ID of this Expected Power Shelf
	ID uuid.UUID `json:"id"`
	// BmcMacAddress is the MAC address of the expected power shelf's BMC
	BmcMacAddress string `json:"bmcMacAddress"`
	// SiteID is the ID of the site this power shelf belongs to
	SiteID uuid.UUID `json:"siteId"`
	// Site is the site information
	Site *APISite `json:"site,omitempty"`
	// ShelfSerialNumber is the serial number of the expected power shelf
	ShelfSerialNumber string `json:"shelfSerialNumber"`
	// IpAddress is the IP address of the expected power shelf
	IpAddress *string `json:"ipAddress"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected power shelf
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected power shelf
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected power shelf
	Model *string `json:"model"`
	// Description is the optional description of the expected power shelf
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected power shelf
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected power shelf
	Labels map[string]string `json:"labels"`
	// Created indicates the ISO datetime string for when the ExpectedPowerShelf was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the ExpectedPowerShelf was last updated
	Updated time.Time `json:"updated"`
}

type APIExpectedPowerShelfCreateRequest struct {
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// BmcMacAddress is the MAC address of the expected power shelf's BMC
	BmcMacAddress string `json:"bmcMacAddress"`
	// DefaultBmcUsername is the username of the expected power shelf's BMC
	DefaultBmcUsername *string `json:"defaultBmcUsername"`
	// DefaultBmcPassword is the password of the expected power shelf's BMC
	DefaultBmcPassword *string `json:"defaultBmcPassword"`
	// ShelfSerialNumber is the serial number of the expected power shelf
	ShelfSerialNumber string `json:"shelfSerialNumber"`
	// IpAddress is the IP address of the expected power shelf
	IpAddress *string `json:"ipAddress"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected power shelf
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected power shelf
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected power shelf
	Model *string `json:"model"`
	// Description is the optional description of the expected power shelf
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected power shelf
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected power shelf
	Labels map[string]string `json:"labels"`
}

type APIExpectedPowerShelfUpdateRequest struct {
	// ID is required for batch updates (must be empty or match path value for single update)
	ID *string `json:"id"`
	// BmcMacAddress is the MAC address of the expected power shelf's BMC
	BmcMacAddress *string `json:"bmcMacAddress"`
	// DefaultBmcUsername is the username of the expected power shelf's BMC
	DefaultBmcUsername *string `json:"defaultBmcUsername"`
	// DefaultBmcPassword is the password of the expected power shelf's BMC
	DefaultBmcPassword *string `json:"defaultBmcPassword"`
	// ShelfSerialNumber is the serial number of the expected power shelf
	ShelfSerialNumber *string `json:"shelfSerialNumber"`
	// IpAddress is the IP address of the expected power shelf
	IpAddress *string `json:"ipAddress"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected power shelf
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected power shelf
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected power shelf
	Model *string `json:"model"`
	// Description is the optional description of the expected power shelf
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected power shelf
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected power shelf
	Labels map[string]string `json:"labels"`
}

type APIExpectedSwitch struct {
	// ID is the ID of this Expected Switch
	ID uuid.UUID `json:"id"`
	// BmcMacAddress is the MAC address of the expected switch's BMC
	BmcMacAddress string `json:"bmcMacAddress"`
	// SiteID is the ID of the site this switch belongs to
	SiteID uuid.UUID `json:"siteId"`
	// Site is the site information
	Site *APISite `json:"site,omitempty"`
	// SwitchSerialNumber is the serial number of the expected switch
	SwitchSerialNumber string `json:"switchSerialNumber"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected switch
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected switch
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected switch
	Model *string `json:"model"`
	// Description is the optional description of the expected switch
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected switch
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected switch
	Labels map[string]string `json:"labels"`
	// Created indicates the ISO datetime string for when the ExpectedSwitch was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the ExpectedSwitch was last updated
	Updated time.Time `json:"updated"`
}

type APIExpectedSwitchCreateRequest struct {
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// BmcMacAddress is the MAC address of the expected switch's BMC
	BmcMacAddress string `json:"bmcMacAddress"`
	// DefaultBmcUsername is the username of the expected switch's BMC
	DefaultBmcUsername *string `json:"defaultBmcUsername"`
	// DefaultBmcPassword is the password of the expected switch's BMC
	DefaultBmcPassword *string `json:"defaultBmcPassword"`
	// SwitchSerialNumber is the serial number of the expected switch
	SwitchSerialNumber string `json:"switchSerialNumber"`
	// NvOsUsername is the NVOS username of the expected switch
	NvOsUsername *string `json:"nvOsUsername"`
	// NvOsPassword is the NVOS password of the expected switch
	NvOsPassword *string `json:"nvOsPassword"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected switch
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected switch
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected switch
	Model *string `json:"model"`
	// Description is the optional description of the expected switch
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected switch
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected switch
	Labels map[string]string `json:"labels"`
}

type APIExpectedSwitchUpdateRequest struct {
	// ID is required for batch updates (must be empty or match path value for single update)
	ID *string `json:"id"`
	// BmcMacAddress is the MAC address of the expected switch's BMC
	BmcMacAddress *string `json:"bmcMacAddress"`
	// DefaultBmcUsername is the username of the expected switch's BMC
	DefaultBmcUsername *string `json:"defaultBmcUsername"`
	// DefaultBmcPassword is the password of the expected switch's BMC
	DefaultBmcPassword *string `json:"defaultBmcPassword"`
	// SwitchSerialNumber is the serial number of the expected switch
	SwitchSerialNumber *string `json:"switchSerialNumber"`
	// NvOsUsername is the NVOS username of the expected switch
	NvOsUsername *string `json:"nvOsUsername"`
	// NvOsPassword is the NVOS password of the expected switch
	NvOsPassword *string `json:"nvOsPassword"`
	// RackID is the optional rack identifier
	RackID *string `json:"rackId"`
	// Name is the optional name of the expected switch
	Name *string `json:"name"`
	// Manufacturer is the optional manufacturer of the expected switch
	Manufacturer *string `json:"manufacturer"`
	// Model is the optional model of the expected switch
	Model *string `json:"model"`
	// Description is the optional description of the expected switch
	Description *string `json:"description"`
	// FirmwareVersion is the optional firmware version of the expected switch
	FirmwareVersion *string `json:"firmwareVersion"`
	// SlotID is the optional slot identifier
	SlotID *int32 `json:"slotId"`
	// TrayIdx is the optional tray index
	TrayIdx *int32 `json:"trayIdx"`
	// HostID is the optional host identifier
	HostID *int32 `json:"hostId"`
	// Labels is the labels of the expected switch
	Labels map[string]string `json:"labels"`
}

type APIFabric struct {
	// ID is the guid identifier for the Fabric
	ID string `json:"id"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// InfrastructureProviderID is the ID of the InfrastructureProvider
	InfrastructureProviderID string `json:"infrastructureProviderId"`
	// InfrastructureProvider is the summary of the InfrastructureProvider
	InfrastructureProvider *APIInfrastructureProviderSummary `json:"infrastructureProvider,omitempty"`
	// Status represents the status of the machine
	Status string `json:"status"`
	// StatusHistory is the history of statuses for the Fabric
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// CreatedAt indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// UpdatedAt indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIFabricSummary struct {
	// ID of the Fabric
	ID string `json:"id"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Status is the status of the Fabric
	Status string `json:"status"`
}

type APIFieldDiff struct {
	FieldName     string `json:"fieldName"`
	ExpectedValue string `json:"expectedValue"`
	ActualValue   string `json:"actualValue"`
}

type APIGetTaskRequest struct {
	SiteID string `query:"siteId"`
}

type APIHealthCheck struct {
	// IsHealthy provides a flag to accompany an error status code
	IsHealthy bool `json:"is_healthy"`
	// Error contains an error message in case of health issues
	Error *string `json:"error"`
}

type APIIPBlock struct {
	// ID is the unique UUID v4 identifier for the IPBlock
	ID string `json:"id"`
	// Name is the name of the IPBlock
	Name string `json:"name"`
	// Description is the description of the IPBlock
	Description *string `json:"description"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// InfrastructureProviderID is the ID of the InfrastructureProvider
	InfrastructureProviderID string `json:"infrastructureProviderId"`
	// InfrastructureProvider is the summary of the InfrastructureProvider
	InfrastructureProvider *APIInfrastructureProviderSummary `json:"infrastructureProvider,omitempty"`
	// TenantID is the ID of the Tenant
	TenantID *string `json:"tenantId"`
	// Tenant is the summary of the tenant
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// RoutingType is the routingType of the IPBlock
	RoutingType string `json:"routingType"`
	// Prefix is the prefix of the network in CIDR notation
	Prefix string `json:"prefix"`
	// PrefixLength is the length of the network prefix
	PrefixLength int `json:"prefixLength"`
	// ProtocolVersion is the version of the ip network IPv4 or IPv6
	ProtocolVersion string `json:"protocolVersion"`
	// Status is the status of the IPBlock
	Status string `json:"status"`
	// StatusHistory is the history of statuses for the IPBlock
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// UsageStats is the usage summary from IPAM for the IPBlock
	UsageStats *APIIPBlockUsageStats `json:"usageStats,omitempty"`
	// CreatedAt indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// UpdatedAt indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIIPBlockCreateRequest struct {
	// Name is the name of the IPBlock
	Name string `json:"name"`
	// Description is the description of the IPBlock
	Description *string `json:"description"`
	// SiteID is the ID of the site
	SiteID string `json:"siteId"`
	// RoutingType is the routing type of the IPBlock
	RoutingType string `json:"routingType"`
	// Prefix is the prefix of the network in CIDR notation
	Prefix string `json:"prefix"`
	// BlockSize is the legacy field for prefixLength
	// NOTE: This field has been deprecated
	BlockSize *int `json:"blockSize"`
	// PrefixLength is the length of the prefix
	PrefixLength int `json:"prefixLength"`
	// ProtocolVersion is the version of the ip network ipv4 or ipv6
	ProtocolVersion string `json:"protocolVersion"`
}

type APIIPBlockStats struct {
	// Total is the total number of the IPBlock object in Forge Cloud
	Total int `json:"total"`
	// Pending is the total number of pending IPBlock object in Forge Cloud
	Pending int `json:"pending"`
	// Provisioning is the total number of provisioning IPBlock object in Forge Cloud
	Provisioning int `json:"provisioning"`
	// Ready is the total number of ready IPBlock object in Forge Cloud
	Ready int `json:"ready"`
	// Deleting is the total number of deleting IPBlock object in Forge Cloud
	Deleting int `json:"deleting"`
	// Error is the total number of error IPBlock object in Forge Cloud
	Error int `json:"error"`
}

type APIIPBlockSummary struct {
	// ID of the IP Block
	ID string `json:"id"`
	// Name of the IPBlock, only lowercase characters, digits, hyphens and cannot begin/end with hyphen
	Name string `json:"name"`
	// RoutingType is the routingType of the IPBlock
	RoutingType string `json:"routingType"`
	// Prefix is the prefix of the network in CIDR notation
	Prefix string `json:"prefix"`
	// PrefixLength is the length of the network prefix
	PrefixLength int `json:"prefixLength"`
	// Status is the status of the IPBlock
	Status string `json:"status"`
}

type APIIPBlockUpdateRequest struct {
	// Name is the name of the IPBlock
	Name *string `json:"name"`
	// Description is the description of the IPBlock
	Description *string `json:"description"`
}

type APIIPBlockUsageStats struct {
	// AvailableIPs is the total number of available IPs in the IPBlock
	AvailableIPs uint64 `json:"availableIPs"`
	// AcquiredIPs the number of acquired IPs from the IPBlock
	AcquiredIPs uint64 `json:"acquiredIPs"`
	// AvailablePrefixes is a list of prefixes which are available in the IPBlock
	AvailablePrefixes []string `json:"availablePrefixes"`
	// AvailableSmallestPrefixes is the count of available Prefixes with 2 countable Bits
	AvailableSmallestPrefixes uint64 `json:"availableSmallestPrefixes"`
	// AcquiredPrefixes the number of acquired prefixes from the IPBlock
	AcquiredPrefixes uint64 `json:"acquiredPrefixes"`
}

type APIInfiniBandInterface struct {
	// ID is the unique UUID v4 identifier for the InfiniBandInterface
	ID string `json:"id"`
	// InstanceID is the ID of the associated Instance
	InstanceID string `json:"instanceId"`
	// Instance is the summary of the Instance
	Instance *APIInstanceSummary `json:"instance,omitempty"`
	// InfiniBandPartitonID is the ID of the associated InfiniBandPartition
	InfiniBandPartitonID string `json:"partitionId"`
	// InfiniBandPartiton is the summary of the InfiniBandPartiton
	InfiniBandPartition *APIInfiniBandPartitionSummary `json:"partition,omitempty"`
	// Device is the name of the InfiniBand device
	Device string `json:"device"`
	// Vendor is the name of the vendor of the InfiniBand device
	Vendor *string `json:"vendor"`
	// DeviceInstance is the index of the device where partition attach to
	DeviceInstance int `json:"deviceInstance"`
	// IsPhysical indicates whether the Subnet is bound on a physical Interface
	IsPhysical bool `json:"isPhysical"`
	// VirtualFunctionID must be specified if isPhysical is false
	VirtualFunctionID *int `json:"virtualFunctionId"`
	// GUID must be specified if isPhysical is false
	GUID *string `json:"guid"`
	// Status is the status of the InfiniBandInterface
	Status string `json:"status"`
	// Created is the date and time the entity was created
	Created time.Time `json:"created"`
	// Updated is the date and time the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIInfiniBandInterfaceCreateOrUpdateRequest struct {
	// InfiniBandPartitionID is the ID of the InfiniBandPartition
	InfiniBandPartitionID string `json:"partitionId"`
	// Device is the name of the InfinitBand device to use
	Device string `json:"device"`
	// Vendor is the name of the vendor of the InfiniBand device
	Vendor *string `json:"vendor"`
	// DeviceInstance is the index of the device to use
	DeviceInstance int `json:"deviceInstance"`
	// IsPhysical indicates whether the Partition is attach to Instance over a physical Interface
	IsPhysical bool `json:"isPhysical"`
	// VirtualFunctionID must be specified if isPhysical is false
	VirtualFunctionID *int `json:"virtualFunctionId"`
}

type APIInfiniBandPartition struct {
	// ID is the unique UUID v4 identifier for the InfiniBand Partition
	ID string `json:"id"`
	// Name is the name of the InfiniBand Partition
	Name string `json:"name"`
	// Description is the description of the InfiniBand Partition
	Description *string `json:"description"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// Tenant is the summary of the tenant
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// Controller IB Partition ID is the ID of the Site Controller IB partition
	ControllerIBPartitionID *string `json:"controllerIBPartitionId"`
	// Partition Key is the key of IB partition
	PartitionKey *string `json:"partitionKey"`
	// Partition Name is the name of IB partition
	PartitionName *string `json:"partitionName"`
	// Service Level is the service level of IB partition
	ServiceLevel *int `json:"serviceLevel"`
	// Rate Limit is the rate limit of IB partition
	RateLimit *float32 `json:"rateLimit"`
	// Mtu of the IB partition
	Mtu *int `json:"mtu"`
	// EnableSharp indicates if sharp enable on the IB partition or not
	EnableSharp *bool `json:"enableSharp"`
	// Labels is the labels of the InfiniBand Partition
	Labels map[string]string `json:"labels"`
	// Status is the status o the InfiniBand Partition
	Status string `json:"status"`
	// StatusHistory is the status detail records for the InfiniBand Partition over time
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// Created indicates the ISO datetime string for when the InfiniBand Partition was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the InfiniBand Partition was last updated
	Updated time.Time `json:"updated"`
}

type APIInfiniBandPartitionCreateRequest struct {
	// Name is the name of the InfiniBand Partition
	Name string `json:"name"`
	// Description is the description of the InfiniBand Partition
	Description *string `json:"description"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Labels is the labels of the InfiniBand Partition
	Labels map[string]string `json:"labels"`
}

type APIInfiniBandPartitionSummary struct {
	// ID of the InfiniBand Partition
	ID string `json:"id"`
	// Name of the InfiniBand Partition
	Name string `json:"name"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Controller IB Partition is the ID of the Site Controller Partition corresponding to the InfiniBand Partition
	ControllerIBPartitionID *string `json:"controllerIBPartitionId"`
	// Status is the status of the InfiniBand Partition
	Status string `json:"status"`
}

type APIInfiniBandPartitionUpdateRequest struct {
	// Name is the name of the InfiniBand Partition
	Name *string `json:"name"`
	// Description is the description of the InfiniBand Partition
	Description *string `json:"description"`
	// Labels is the labels of the InfiniBand Partition
	Labels map[string]string `json:"labels"`
}

type APIInfrastructureProvider struct {
	// ID is the unique UUID v4 identifier for the Infrastructure Provider
	ID string `json:"id"`
	// Org contains the name of the org this Infrastructure Provider belongs to
	Org string `json:"org"`
	// OrgDisplayName contains the display name of the org this Infrastructure Provider belongs to
	OrgDisplayName *string `json:"orgDisplayName"`
	// CreatedAt indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// UpdatedAt indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIInfrastructureProviderStats struct {
	// Machine is the data structure to capture API representation of an Machine Stats associated with Infrastructure Provider
	Machine APIMachineStats `json:"machine"`
	// IPBlock is the data structure to capture API representation of a IPBlock Stats associated with Infrastructure Provider
	IPBlock APIIPBlockStats `json:"ipBlock"`
	// TenantAccount is the data structure to capture API representation of a TenantAccount Stats associated with Infrastructure Provider
	TenantAccount APITenantAccountStats `json:"tenantAccount"`
}

type APIInfrastructureProviderSummary struct {
	// Org contains the name of the org the Infrastructure Provider belongs to
	Org string `json:"org"`
	// OrgDisplayName contains the display name of the org this Infrastructure Provider belongs to
	OrgDisplayName *string `json:"orgDisplayName"`
}

type APIInstance struct {
	// ID is the unique UUID v4 identifier for the Instance
	ID string `json:"id"`
	// Name of the Instance
	Name string `json:"name"`
	// Description is the description of the Instance
	Description *string `json:"description"`
	// ControllerInstanceID is the ID of the Instance in Site Controller
	ControllerInstanceID string `json:"controllerInstanceId"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// Tenant is the summary of the tenant
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// InfrastructureProviderID is the ID of the Infrastructure Provider
	InfrastructureProviderID string `json:"infrastructureProviderId"`
	// InfrastructureProvider is the summary of the Infrastructure Provider
	InfrastructureProvider *APIInfrastructureProviderSummary `json:"infrastructureProvider,omitempty"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// InstanceTypeID is the ID of the InstanceType
	InstanceTypeID *string `json:"instanceTypeId"`
	// InstanceType is the summary of the InstanceType
	InstanceType *APIInstanceTypeSummary `json:"instanceType,omitempty"`
	// VpcID is the ID of the VPC
	VpcID string `json:"vpcId"`
	// Vpc is the summary of the VPC
	Vpc *APIVpcSummary `json:"vpc,omitempty"`
	// SecondaryVpcIDs lists non-primary VPC UUIDs derived from prefix-backed
	// interfaces attached to the Instance. These values are populated from
	// interface relations rather than stored directly on the Instance record.
	SecondaryVpcIDs []string `json:"secondaryVpcIds"`
	// MachineID is the ID of the Machine
	MachineID *string `json:"machineId"`
	// Machine is the summary of the Machine
	Machine *APIMachineSummary `json:"machine,omitempty"`
	// OperatingSystemID is the ID of the OperatingSystem
	OperatingSystemID *string `json:"operatingSystemId"`
	// OperatingSystem is the summary of the OperatingSystem
	OperatingSystem *APIOperatingSystemSummary `json:"operatingSystem,omitempty"`
	// ipxeScript is an attribute which is inherited from Operating System
	IpxeScript *string `json:"ipxeScript"`
	// AlwaysBootWithCustomIpxe is an attribute which is specified by user if instance boot with ipxe or not
	AlwaysBootWithCustomIpxe bool `json:"alwaysBootWithCustomIpxe"`
	// PhoneHomeEnabled is an attribute which is specified by user if instance needs to be enabled for phone home or not
	PhoneHomeEnabled bool `json:"phoneHomeEnabled"`
	// UserData is inherited from Operating System or specified by user if allowed
	UserData *string `json:"userData"`
	// Labels is Instace labels specified by user
	Labels map[string]string `json:"labels"`
	// IsUpdatePending is an attribute suggest if instance update pending or not
	IsUpdatePending bool `json:"isUpdatePending"`
	// SerialConsoleURL is the ssh serial console URL associated with the instance
	SerialConsoleURL *string `json:"serialConsoleUrl"`
	// NetworkSecurityGroupID is the ID of attached NSG, if any
	NetworkSecurityGroupID *string `json:"networkSecurityGroupId"`
	// NetworkSecurityGroup holds the summary for attached NSG, if requested via includeRelation
	NetworkSecurityGroup *APINetworkSecurityGroupSummary `json:"networkSecurityGroup,omitempty"`
	// NetworkSecurityGroupPropagationDetails is the propagation details for the attched NSG, if any
	NetworkSecurityGroupPropagationDetails *APINetworkSecurityGroupPropagationDetails `json:"networkSecurityGroupPropagationDetails"`
	// NetworkSecurityGroupInherited indicates if the Instance is inheriting Network Security Group rules from parent VPC
	NetworkSecurityGroupInherited bool `json:"networkSecurityGroupInherited"`
	// TPM EK Cert
	TpmEkCertificate *string `json:"tpmEkCertificate"`
	// Status is the status of the Instance
	Status string `json:"status"`
	// Interfaces are list of the subnet associated with the Instance
	Interfaces []APIInterface `json:"interfaces"`
	// InfiniBandInterfaces are list of the InfiniBandInterface associated with the Instance
	InfiniBandInterfaces []APIInfiniBandInterface `json:"infinibandInterfaces"`
	// DpuExtensionServiceDeployments are list of the DpuExtensionServiceDeployments associated with the Instance
	DpuExtensionServiceDeployments []APIDpuExtensionServiceDeployment `json:"dpuExtensionServiceDeployments"`
	// NVLinkInterfaces are list of the NVLinkInterface associated with the Instance
	NVLinkInterfaces []APINVLinkInterface `json:"nvLinkInterfaces"`
	// SSHKeyGroupIDs are list of the ssh key group IDs associated with the Instance
	SSHKeyGroupIDs []string `json:"sshKeyGroupIds"`
	// SSHKeyGroups are list of the ssh key group associated with the Instance
	SSHKeyGroups []APISSHKeyGroupSummary `json:"sshKeyGroups"`
	// StatusHistory is the history of statuses for the Instance
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// Created indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
	// Deprecations is the list of deprecation messages denoting fields which are being deprecated
	Deprecations []APIDeprecation `json:"deprecations,omitempty"`
}

type APIInstanceCreateRequest struct {
	// Name is the name of the Instance
	Name string `json:"name"`
	// Description is the description of the Instance
	Description *string `json:"description"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// InstanceTypeID is the ID of the Instance Type. Only InstanceTypeID or Machineid can be present
	InstanceTypeID *string `json:"instanceTypeId"`
	// VpcID is the ID of the VPC containing the Instance
	VpcID string `json:"vpcId"`
	// SecondaryVpcIDs lists additional VPC UUIDs for prefix-backed, non-primary
	// network interfaces on the Instance. Validate() rejects this field unless
	// every entry in Interfaces uses vpcPrefixId, and the create handler then
	// verifies that the supplied UUIDs exactly match the VPCs resolved from those
	// prefix-backed interfaces.
	SecondaryVpcIDs []string `json:"secondaryVpcIds"`
	// OperatingSystemID is the ID of the Operating System
	OperatingSystemID *string `json:"operatingSystemId"`
	// IpxeScript is the iPXE script for the Operating System
	IpxeScript *string `json:"ipxeScript"`
	// AlwaysBootWithCustomIpxe is the flag to allow always boot with ipxe
	AlwaysBootWithCustomIpxe *bool `json:"alwaysBootWithCustomIpxe"`
	// PhoneHomeEnabled is the flag to allow enable phone home for the instance
	PhoneHomeEnabled *bool `json:"phoneHomeEnabled"`
	// UserData is the ID of the Operating System
	UserData *string `json:"userData"`
	// Interfaces is the list of Interfaces to create for the Instance
	Interfaces []APIInterfaceCreateOrUpdateRequest `json:"interfaces"`
	// InfiniBandInterfaces is the list of InfiniBandInterface to create for the Instance
	InfiniBandInterfaces []APIInfiniBandInterfaceCreateOrUpdateRequest `json:"infinibandInterfaces"`
	// DpuExtensionServiceDeployments is the list of DpuExtensionServiceDeployments to create for the Instance
	DpuExtensionServiceDeployments []APIDpuExtensionServiceDeploymentRequest `json:"dpuExtensionServiceDeployments"`
	// NVLinkInterfaces is the list of NVLinkInterface to create for the Instance
	NVLinkInterfaces []APINVLinkInterfaceCreateOrUpdateRequest `json:"nvLinkInterfaces"`
	// SSHKeyGroupIDs is a list of SSHKeyID objects
	SSHKeyGroupIDs []string `json:"sshKeyGroupIds"`
	// Labels is a key value objects
	Labels map[string]string `json:"labels"`
	// NetworkSecurityGroupID is the ID if a desired
	// NSG to attach to the instance
	NetworkSecurityGroupID *string `json:"networkSecurityGroupId"`
	// MachineID is the ID of the Machine. Only MachineID or InstanceTypeID can be present
	MachineID *string `json:"machineId"`
	// AllowUnhealthyMachine is a flag that can be used to target Machines are in maintenance or have health alerts preventing regular provision flow.
	AllowUnhealthyMachine *bool `json:"allowUnhealthyMachine"`
}

type APIInstanceDeleteRequest struct {
	// MachineHealthIssue is the report of a machine health issue
	MachineHealthIssue *APIMachineHealthIssueReport `json:"machineHealthIssue"`
	IsRepairTenant     *bool                        `json:"isRepairTenant"`
}

type APIInstanceStats struct {
	// Total is the total number of the Instances
	Total int `json:"total"`
	// Pending is the total number of pending Instances
	Pending int `json:"pending"`
	// Terminating is the total number of provisioning InstanceS
	Terminating int `json:"terminating"`
	// Ready is the total number of ready Instances
	Ready int `json:"ready"`
	// Updating is the total number of Instances receiving system updates
	Updating int `json:"updating"`
	// Registering is the total number of registering Instances
	Registering int `json:"registering"`
	// Error is the total number of error Instances
	Error int `json:"error"`
}

type APIInstanceSummary struct {
	// ID of the Instance
	ID string `json:"id"`
	// Name of the Instance, only lowercase characters, digits, hyphens and cannot begin/end with hyphen
	Name string `json:"name"`
	// InfrastructureProviderID is the ID of the Infrastructure Provider
	InfrastructureProviderID string `json:"infrastructureProviderId"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// InstanceTypeID is the ID of the InstanceType
	InstanceTypeID string `json:"instanceTypeId"`
	// ControllerInstanceID is the ID of the Instance in Site Controller
	ControllerInstanceID string `json:"controllerInstanceId"`
	// Status is the status of the Instance
	Status string `json:"status"`
}

type APIInstanceType struct {
	// ID is the unique UUID v4 identifier for the Instance Type
	ID string `json:"id"`
	// Name is the name of the Instance Type
	Name string `json:"name"`
	// Description is the description of the Instance Type
	Description *string `json:"description"`
	// ControllerMachineType is the Machine type assigned by Site Controller
	ControllerMachineType *string `json:"controllerMachineType"`
	// InfrastructureProviderID is the ID of the InfrastructureProvider that owns the Instance Type
	InfrastructureProviderID string `json:"infrastructureProviderId"`
	// InfrastructureProvider is the summary of the InfrastructureProvider
	InfrastructureProvider *APIInfrastructureProviderSummary `json:"infrastructureProvider,omitempty"`
	// SiteID is the ID of the Site that owns the Instance Type
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// Labels is the labels of the Instance Type
	Labels map[string]string `json:"labels"`
	// MachineCapabilities is the list of capabilities that are supported by the Machine's of this Instance Type
	MachineCapabilities []APIMachineCapability `json:"machineCapabilities"`
	// MachineInstanceTypes is the list of machines that are associated to this Instance Type
	MachineInstanceTypes []APIMachineInstanceType `json:"machineInstanceTypes,omitempty"`
	// AllocationStats is the stats of allocation that are associated to this Instance Type
	AllocationStats *APIAllocationStats `json:"allocationStats,omitempty"`
	// Deprecations is the list of deprecation messages denoting fields which are being deprecated
	Deprecations []APIDeprecation `json:"deprecations,omitempty"`
	// Status is the status of the Instance Type
	Status string `json:"status"`
	// StatusHistory is the history of statuses for the Instance Type
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// Created is the date and time the entity was created
	Created time.Time `json:"created"`
	// Updated is the date and time the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIInstanceTypeCreateRequest struct {
	// Name is the name of the InstanceType
	Name string `json:"name"`
	// Description is the description of the Instance Type
	Description *string `json:"description"`
	// SiteID is the ID of the site
	SiteID string `json:"siteId"`
	// Labels is the labels of the Instance Type
	Labels map[string]string `json:"labels"`
	// ControllerMachineType is the Site Controller assigned Machine type
	ControllerMachineType *string `json:"controllerMachineType"`
	// MachineCapabilities is the list of Machine Capabilities to match
	MachineCapabilities []APIMachineCapability `json:"machineCapabilities"`
}

type APIInstanceTypeSummary struct {
	// ID of the Instance Type
	ID string `json:"id"`
	// Name of the InstanceType, only lowercase characters, digits, hyphens and cannot begin/end with hyphen
	Name string `json:"name"`
	// InfrastructureProviderID is the ID of the InfrastructureProvider that owns the Instance Type
	InfrastructureProviderID string `json:"infrastructureProviderId"`
	// SiteID is the ID of the Site that owns the Instance Type
	SiteID string `json:"siteId"`
	// Status is the status of the Instance Type
	Status string `json:"status"`
}

type APIInstanceTypeUpdateRequest struct {
	// Name is the name of the Instance Type
	Name *string `json:"name"`
	// Description is the description of the Instance Type
	Description *string `json:"description"`
	// Labels is the labels of the Instance Type
	Labels map[string]string `json:"labels"`
	// MachineCapabilities is the list of Machine Capabilities to match
	MachineCapabilities []APIMachineCapability `json:"machineCapabilities"`
}

type APIInstanceUpdateRequest struct {
	// Name is the name of the Instance
	Name *string `json:"name"`
	// Description is the description of the Instance
	Description *string `json:"description"`
	// Labels is a key value objects
	Labels map[string]string `json:"labels"`
	// TriggerReboot is the flag to trigger reboot
	TriggerReboot *bool `json:"triggerReboot"`
	// RebootWithCustomIpxe is the flag to allow reboot with ipxe
	RebootWithCustomIpxe *bool `json:"rebootWithCustomIpxe"`
	// ApplyUpdatesOnReboot is the flag to allow update first before reboot
	ApplyUpdatesOnReboot *bool `json:"applyUpdatesOnReboot"`
	// OperatingSystemID is the ID of the Operating System
	OperatingSystemID *string `json:"operatingSystemId"`
	// IpxeScript is the iPXE script for the Operating System
	IpxeScript *string `json:"ipxeScript"`
	// UserData is the user-date to be used when booting; e.g., a cloud-init config
	UserData *string `json:"userData"`
	// PhoneHomeEnabled is an attribute which is specified by user if Instance needs to be enabled for phone home or not
	PhoneHomeEnabled *bool `json:"phoneHomeEnabled"`
	// AlwaysBootWithCustomIpxe is an attribute which is specified by user if instance boot with ipxe or not
	AlwaysBootWithCustomIpxe *bool `json:"alwaysBootWithCustomIpxe"`
	// SecondaryVpcIDs lists additional VPC IDs for prefix-backed, non-primary
	// network interfaces on the Instance. This field will be rejected unless
	// Interfaces is provided and non-empty and every entry in Interfaces uses
	// vpcPrefixId. The update handler then verifies that the supplied UUIDs
	// exactly match the VPCs resolved from those prefix-backed interfaces.
	SecondaryVpcIDs []string `json:"secondaryVpcIds"`
	// Interfaces is the list of Interfaces to update for the Instance
	Interfaces []APIInterfaceCreateOrUpdateRequest `json:"interfaces"`
	// InfiniBandInterfaces is the list of InfiniBandInterface to update for the Instance
	InfiniBandInterfaces []APIInfiniBandInterfaceCreateOrUpdateRequest `json:"infinibandInterfaces"`
	// DpuExtensionServiceDeployments is the list of DpuExtensionServiceDeployments to update for the Instance
	DpuExtensionServiceDeployments []APIDpuExtensionServiceDeploymentRequest `json:"dpuExtensionServiceDeployments"`
	// NVLinkInterfaces is the list of NVLinkInterface to update for the Instance
	NVLinkInterfaces []APINVLinkInterfaceCreateOrUpdateRequest `json:"nvLinkInterfaces"`
	// SSHKeyGroupIDs is a list of SSHKeyID objects
	SSHKeyGroupIDs []string `json:"sshKeyGroupIds"`
	// NetworkSecurityGroupID is the ID of Network Security Group to attach to the Instance
	NetworkSecurityGroupID *string `json:"networkSecurityGroupId"`
}

type APIInterface struct {
	// ID is the unique UUID v4 identifier for the Interface
	ID string `json:"id"`
	// InstanceID is the ID of the associated Instance
	InstanceID string `json:"instanceId"`
	// Instance is the summary of the Instance
	Instance *APIInstanceSummary `json:"instance,omitempty"`
	// SubnetID is the ID of the associated Subnet
	SubnetID *string `json:"subnetId"`
	// Subnet is the summary of the Subnet
	Subnet *APISubnetSummary `json:"subnet,omitempty"`
	// VpcPrefixID is the ID of the associated VpcPrefix
	VpcPrefixID *string `json:"vpcPrefixId"`
	// VpcPrefix is the summary of the VpcPrefix
	VpcPrefix *APIVpcPrefixSummary `json:"vpcprefix,omitempty"`
	// Device is the device name of the Interface
	Device *string `json:"device"`
	// DeviceInstance is the ID of the DeviceInstance
	DeviceInstance *int `json:"deviceInstance"`
	// VirtualFunctionID is the ID of the Virtual Function
	VirtualFunctionID *int `json:"virtualFunctionId"`
	// IsPhysical indicates whether the Subnet is bound on a physical Interface
	IsPhysical bool `json:"isPhysical"`
	// MacAddress is the MAC address of the Interface
	MacAddress *string `json:"macAddress"`
	// IPAddresses is the list of IP addresses assigned to the Interface
	IPAddresses []string `json:"ipAddresses"`
	// RequestedIpAddress is the explicitly requested IP address for the Interface
	RequestedIpAddress *string `json:"requestedIpAddress"`
	// Status is the status of the Interface
	Status string `json:"status"`
	// Created is the date and time the entity was created
	Created time.Time `json:"created"`
	// Updated is the date and time the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIInterfaceCreateOrUpdateRequest struct {
	// SubnetID is the ID of the Subnet
	SubnetID *string `json:"subnetId"`
	// VpcPrefixID is the ID of the VpcPrefix
	VpcPrefixID *string `json:"vpcPrefixId"`
	// IPAddress is the explicitly requested IP address for the Interface
	IPAddress *string `json:"ipAddress"`
	// Device is the device name of the Interface
	Device *string `json:"device"`
	// DeviceInstance is the ID of the DeviceInstance
	DeviceInstance *int `json:"deviceInstance"`
	// VirtualFunctionID is the ID of the Virtual Function
	VirtualFunctionID *int `json:"virtualFunctionId"`
	// IsPhysical indicates whether the Subnet is bound on a physical Interface
	IsPhysical bool `json:"isPhysical"`
}

type APIMachine struct {
	// ID is the unique UUID v4 identifier for the Machine
	ID string `json:"id"`
	// InfrastructureProviderID is the ID of the InfrastructureProvider
	InfrastructureProviderID string `json:"infrastructureProviderId"`
	// InfrastructureProvider is the summary of the InfrastructureProvider
	InfrastructureProvider *APIInfrastructureProviderSummary `json:"infrastructureProvider,omitempty"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// InstanceTypeID is the ID of the associated Instance Type
	InstanceTypeID *string `json:"instanceTypeId"`
	// InstanceType is the summary of the associated Instance Type
	InstanceType *APIInstanceTypeSummary `json:"instanceType,omitempty"`
	// InstanceID is the ID of the associated Instance (if any)
	InstanceID *string `json:"instanceId"`
	// Instance is the summary of the associated Instance (if any)
	Instance *APIInstanceSummary `json:"instance,omitempty"`
	// TenantID is the ID of the Tenant that owns the Instance associated (if any)
	TenantID *string `json:"tenantId"`
	// Tenant is the summary of the Tenant that owns the Instance associated (if any)
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// ControllerMachineID is the ID of the controllerMachine
	ControllerMachineID string `json:"controllerMachineId"`
	// ControllerMachineType is the type of the controller machine
	ControllerMachineType *string `json:"controllerMachineType"`
	// HwSkuDeviceType is the sku derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.
	HwSkuDeviceType *string `json:"hwSkuDeviceType"`
	// Vendor is the vendor of the Machine
	Vendor *string `json:"vendor"`
	// ProductName is the product name of the Machine
	ProductName *string `json:"productName"`
	// SerialNumber is the serial number of the Machine
	SerialNumber *string `json:"serialNumber"`
	// Hostname is the hostname of the Machine
	Hostname *string `json:"hostname"`
	// MachineCapabilities is the list of capabilities of the machine
	MachineCapabilities []APIMachineCapability `json:"machineCapabilities"`
	// MachineInterfaces is the list of admin interfaces of the machine
	MachineInterfaces []APIMachineInterface `json:"machineInterfaces"`
	// MaintenanceMessage is the message to display during maintenance mode
	MaintenanceMessage *string `json:"maintenanceMessage"`
	// Metadata contains additional metadata about the machine
	Metadata *APIMachineMetadata `json:"metadata,omitempty"`
	// Health contains health information about the machine
	Health *APIMachineHealth `json:"health"`
	// Labels is VPC labels specified by user
	Labels map[string]string `json:"labels"`
	// Status represents the status of the machine
	Status string `json:"status"`
	// IsUsableByTenant indicates whether the machine is usable by or currently in use by a tenant.
	// See: https://jirasw.nvidia.com/browse/FORGE-7530
	IsUsableByTenant bool `json:"isUsableByTenant"`
	// StatusHistory is the history of statuses for the Machine
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// CreatedAt indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// UpdatedAt indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
	// Deprecations is the list of deprecation messages denoting fields which are being deprecated
	Deprecations []APIDeprecation `json:"deprecations,omitempty"`
}

type APIMachineCapability struct {
	// Type is the type of the machine capability
	Type string `json:"type"`
	// Name describes the capability
	Name string `json:"name"`
	// Frequency describes the frequency of the capability
	Frequency *string `json:"frequency,omitempty"`
	// Cores describes the number of cores for the capability
	Cores *int `json:"cores,omitempty"`
	// Threads describes the number of threads for the capability
	Threads *int `json:"threads,omitempty"`
	// Capacity describes the capacity of the capability
	Capacity *string `json:"capacity,omitempty"`
	// Vendor describes the vendor of the capability
	Vendor *string `json:"vendor,omitempty"`
	// InactiveDevices describes a set of inactive devices
	InactiveDevices []int `json:"inactiveDevices,omitempty"`
	// HardwareRevision describes the hardware revision of the capability
	HardwareRevision *string `json:"hardwareRevision,omitempty"`
	// Count describes the number of items present for this capability
	Count *int `json:"count"`
	// DeviceType describes the type of the device
	DeviceType *string `json:"deviceType,omitempty"`
}

type APIMachineGPUInfo struct {
	// Name of the Machine's GPU
	Name *string `json:"name"`
	// Serial is the serial number of the Machine's GPU
	Serial *string `json:"serial"`
	// DriverVersion is the version of the Machine's GPU driver
	DriverVersion *string `json:"driverVersion"`
	// VbiosVersion is the bios version of the Machine's GPU
	VbiosVersion *string `json:"vbiosVersion"`
	// InforomVersion is the info rom version of the Machine's GPU
	InforomVersion *string `json:"inforomVersion"`
	// TotalMemory is the total memory of the Machine's GPU
	TotalMemory *string `json:"totalMemory"`
	// Frequency is the frequency of the Machine's GPU
	Frequency *string `json:"frequency"`
	// PciBusId is the PCI BusId of the Machine's GPU
	PciBusId *string `json:"pciBusId"`
}

type APIMachineGPUStats struct {
	// Name is the GPU name from the MachineCapability record
	Name string `json:"name"`
	// GPUs is the total number of GPUs (summation of all Machine GPU capability counts)
	GPUs int `json:"gpus"`
	// Machines is the number of machines that have this GPU capability
	Machines int `json:"machines"`
}

type APIMachineHealth struct {
	Source               string                         `json:"source"`
	ObservedAt           *string                        `json:"observedAt"`
	ObservedAtDeprecated *string                        `json:"observed_at"`
	Successes            []APIMachineHealthProbeSuccess `json:"successes"`
	Alerts               []APIMachineHealthProbeAlert   `json:"alerts"`
}

type APIMachineHealthIssueReport struct {
	// Category is the type of the issue
	Category string `json:"category"`
	// Summary is the summary of the issue
	Summary *string `json:"summary"`
	// Details is the message of the issue
	Details *string `json:"details"`
}

type APIMachineHealthProbeAlert struct {
	ID                      string   `json:"id"`
	Target                  *string  `json:"target"`
	InAlertSince            *string  `json:"inAlertSince"`
	InAlertSinceDeprecated  *string  `json:"in_alert_since"`
	Message                 string   `json:"message"`
	TenantMessage           *string  `json:"tenantMessage"`
	TenantMessageDeprecated *string  `json:"tenant_message"`
	Classifications         []string `json:"classifications"`
}

type APIMachineHealthProbeSuccess struct {
	ID     string  `json:"id"`
	Target *string `json:"target"`
}

type APIMachineInfiniBandInterface struct {
	// Guid of the Machine's InfiniBandInterface
	Guid *string `json:"guid"`
	// Vendor is the serial number of the Machine's InfiniBandInterface
	Vendor *string `json:"vendor"`
	// Device is the device number of the Machine's InfiniBandInterface
	Device *string `json:"device"`
	// Path is the bios path of the Machine's InfiniBandInterface
	Path *string `json:"path"`
	// NumaNode is the info of numa node Machine's InfiniBandInterface
	NumaNode *int32 `json:"numaNode"`
	// Description is the description the Machine's InfiniBandInterface
	Description *string `json:"description"`
	// Slot is the slot number of the Machine's InfiniBandInterface
	Slot *string `json:"slot"`
}

type APIMachineInstanceType struct {
	// ID is the unique UUID v4 identifier for the Machine Instance Type
	ID string `json:"id"`
	// MachineID is the ID of the associated Machine
	MachineID string `json:"machineId"`
	// InstanceTypeID is the ID of the associated Instance Type
	InstanceTypeID string `json:"instanceTypeId"`
	// Deprecations is the list of deprecation messages denoting fields which are being deprecated
	Deprecations []APIDeprecation `json:"deprecations,omitempty"`
	// Created is the date and time the Machine Instance Type was created
	Created time.Time `json:"created"`
	// Updated is the date and time the Machine Instance Type was last updated
	Updated time.Time `json:"updated"`
}

type APIMachineInstanceTypeCreateRequest struct {
	// MachineID is the ID of the Machine
	MachineIDs []string `json:"machineIds"`
}

type APIMachineInstanceTypeStats struct {
	// ID is the unique identifier for the InstanceType
	ID string `json:"id"`
	// Name is the name of the InstanceType
	Name string `json:"name"`
	// AssignedMachineStats captures the status of all Machines assigned to this Instance Type
	AssignedMachineStats APIMachineStatusBreakdown `json:"assignedMachineStats"`
	// Allocated is the number of Machines of this Instance Type allocated to Tenants
	Allocated int `json:"allocated"`
	// MaxAllocatable is the number of Ready Machines of this Instance Type available for additional allocation to Tenants
	MaxAllocatable int `json:"maxAllocatable"`
	// UsedMachineStats captures the usage status of machines assigned to this instance type
	// that are currently associated with Tenant Instances
	UsedMachineStats APIMachineStatusBreakdown `json:"usedMachineStats"`
	// Tenants is the per-tenant breakdown for this instance type
	Tenants []APIMachineInstanceTypeTenant `json:"tenants"`
}

type APIMachineInstanceTypeSummary struct {
	// Assigned represents machines that have been assigned to an instance type
	Assigned APIMachineStatusBreakdown `json:"assigned"`
	// Unassigned represents machines that have not been assigned to any instance type
	Unassigned APIMachineStatusBreakdown `json:"unassigned"`
}

type APIMachineInstanceTypeTenant struct {
	// ID is the unique identifier for the Tenant
	ID string `json:"id"`
	// Name is the name of the Tenant
	Name string `json:"name"`
	// Allocated is the number of Machines allocated to this Tenant for this Instance Type
	Allocated int `json:"allocated"`
	// UsedMachineStats captures the usage status of machines for this tenant and instance type
	UsedMachineStats APIMachineStatusBreakdown `json:"usedMachineStats"`
	// Allocations is the list of individual allocations for this tenant and instance type
	Allocations []APIMachineInstanceTypeTenantAllocation `json:"allocations"`
}

type APIMachineInstanceTypeTenantAllocation struct {
	// ID is the unique identifier for the Allocation
	ID string `json:"id"`
	// Name is the name of the Allocation
	Name string `json:"name"`
	// Allocated is the total number of machines in this allocation for the instance type
	Allocated int `json:"allocated"`
}

type APIMachineInterface struct {
	// ID is the unique UUID v4 identifier for the Machine Interface
	ID string `json:"id"`
	// MachineID is the ID of the Machine
	MachineID string `json:"machineId"`
	// ControllerInterfaceID is the ID of the interface in Site Controller
	ControllerInterfaceID *string `json:"controllerInterfaceId"`
	// ControllerSegmentID is the ID of the network segment in Site Controller
	ControllerSegmentID *string `json:"controllerSegmentId"`
	// AttachedDpuID is the ID of the DPU that is attached to this interface in Site Controller
	AttachedDPUMachineID *string `json:"attachedDpuMachineID"`
	// SubnetID is the ID of the Subnet
	SubnetID *string `json:"subnetId"`
	// Hostname is the hostname of the Machine Interface
	Hostname *string `json:"hostname"`
	// IsPrimary is a boolean which indicates if the Machine Interface is primary
	IsPrimary bool `json:"isPrimary"`
	// MacAddress is the mac address of the Machine Interface
	MacAddress *string `json:"macAddress"`
	// IPAddresses is the list of ip addresses of the Machine Interface
	IPAddresses []string `json:"ipAddresses"`
	// CreatedAt indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// UpdatedAt indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIMachineMetadata struct {
	// DMIData is the DMI data of the machine
	DMIData *APIDMIData `json:"dmiData,omitempty"`
	// BMCInfo is the BMC Info of the machine
	BMCInfo *APIBMCInfo `json:"bmcInfo,omitempty"`
	// GPUInfo is the list of GPUs for the machine
	GPUs []APIMachineGPUInfo `json:"gpus,omitempty"`
	// NetworkInterfaces is the list of Ethernet interfaces of the machine
	NetworkInterfaces []APIMachineNetworkInterface `json:"networkInterfaces,omitempty"`
	// InfiniBandInterfaces is the list of InfiniBand interfaces of the machine
	InfiniBandInterfaces []APIMachineInfiniBandInterface `json:"infinibandInterfaces,omitempty"`
}

type APIMachineNetworkInterface struct {
	// Name of the Machine's NetworkInterface
	MacAddress *string `json:"macAddress"`
	// Vendor is the serial number of the Machine's NetworkInterface
	Vendor *string `json:"vendor"`
	// Device is the device number of the Machine's NetworkInterface
	Device *string `json:"device"`
	// Path is the bios path of the Machine's NetworkInterface
	Path *string `json:"path"`
	// NumaNode is the info of numa node Machine's NetworkInterface
	NumaNode *int32 `json:"numaNode"`
	// Description is the description the Machine's NetworkInterface
	Description *string `json:"description"`
	// Slot is the slot number of the Machine's NetworkInterface
	Slot *string `json:"slot"`
}

type APIMachineStats struct {
	// Total is the total number of the machine object in Forge Cloud
	Total int `json:"total"`
	// Initializing is the total number of initializing machine object in Forge Cloud
	Initializing int `json:"initializing"`
	// Reset is the total number of reset machine object in Forge Cloud
	Reset int `json:"reset"`
	// Ready is the total number of ready machine object in Forge Cloud
	Ready int `json:"ready"`
	// InUse is the total number of Machines in use by Tenant Instances
	InUse int `json:"inUse"`
	// Error is the total number of error machine object in Forge Cloud
	Error int `json:"error"`
	// Decommissioned is the total number of error decommissioned object in Forge Cloud
	Decommissioned int `json:"decommissioned"`
	// Maintenance is the total number of machines in Maintenance
	Maintenance int `json:"maintenance"`
	// Unknown is the total number of unknown machine object in Forge Cloud
	Unknown int `json:"unknown"`
}

type APIMachineStatusBreakdown struct {
	// Total is the total number of machines in this group
	Total int `json:"total"`
	// Initializing is the number of machines being initialized
	Initializing int `json:"initializing"`
	// Ready is the number of machines in ready state
	Ready int `json:"ready"`
	// InUse is the number of machines currently in use
	InUse int `json:"inUse"`
	// Error is the number of machines in error state
	Error int `json:"error"`
	// Maintenance is the number of machines in maintenance state
	Maintenance int `json:"maintenance"`
	// Unknown is the number of machines in unknown state
	Unknown int `json:"unknown"`
}

type APIMachineSummary struct {
	// ID of the Machine
	ID string `json:"id"`
	// ControllerMachineID is the ID of the controllerMachine
	ControllerMachineID string `json:"controllerMachineId"`
	// ControllerMachineType is the type of the controller machine
	ControllerMachineType *string `json:"controllerMachineType"`
	// HwSkuDeviceType is the sku derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.
	HwSkuDeviceType *string `json:"hwSkuDeviceType"`
	// Vendor is the vendor of the Machine
	Vendor *string `json:"vendor"`
	// ProductName is the product name of the Machine
	ProductName *string `json:"productName"`
	// MaintenanceMessage is the message to display during maintenance mode
	MaintenanceMessage *string `json:"maintenanceMessage"`
	// Status represents the status of the machine
	Status string `json:"status"`
}

type APIMachineUpdateRequest struct {
	// InstanceTypeID is the ID of the InstanceType to set for the Machine
	InstanceTypeID *string `json:"instanceTypeId"`
	// ClearInstanceType indicates that the InstanceType should be cleared
	ClearInstanceType *bool `json:"clearInstanceType"`
	// SetMaintenanceMode enables or disables maintenance mode
	SetMaintenanceMode *bool `json:"setMaintenanceMode"`
	// MaintenanceMessage is the message to display during maintenance mode
	MaintenanceMessage *string `json:"maintenanceMessage"`
	// Labels allows setting a key value pair of arbitrary string metadata for the Machine
	Labels map[string]string `json:"labels"`
}

type APIMachineValidationExternalConfig struct {
	Name        string    `json:"name"`
	Description string    `json:"description"`
	Config      []byte    `json:"config"`
	Version     string    `json:"version"`
	Timestamp   time.Time `json:"timestamp"`
}

type APIMachineValidationExternalConfigCreateRequest struct {
	Name        string  `json:"name"`
	Description *string `json:"description"`
	Config      []byte  `json:"config"`
}

type APIMachineValidationExternalConfigUpdateRequest struct {
	Description *string `json:"description"`
	Config      []byte  `json:"config"`
}

type APIMachineValidationResult struct {
	Name         string    `json:"name"`
	Description  string    `json:"description"`
	Command      string    `json:"command"`
	Args         string    `json:"args"`
	StdOut       string    `json:"stdOut"`
	StdErr       string    `json:"stdErr"`
	Context      string    `json:"context"`
	ExitCode     int       `json:"exitCode"`
	StartTime    time.Time `json:"startTime"`
	EndTime      time.Time `json:"endTime"`
	ValidationID string    `json:"validationID"`
	TestID       string    `json:"testID"`
}

type APIMachineValidationRun struct {
	ValidationID           string                     `json:"validationID"`
	MachineID              string                     `json:"machineID"`
	StartTime              time.Time                  `json:"startTime"`
	EndTime                *time.Time                 `json:"endTime"`
	Name                   string                     `json:"name"`
	Context                string                     `json:"context"`
	Status                 APIMachineValidationStatus `json:"status"`
	DurationToCompleteSecs int                        `json:"durationToCompleteSecs"`
}

type APIMachineValidationState string

type APIMachineValidationStatus struct {
	State     APIMachineValidationState `json:"state"`
	Total     int                       `json:"total"`
	Completed int                       `json:"completed"`
}

type APIMachineValidationTest struct {
	// TestID id of the test
	TestID string `json:"testID"`
	// Name test name
	Name string `json:"name"`
	// Description test description
	Description string `json:"description"`
	// Contexts list of test contexts
	Contexts []string `json:"contexts"`
	// ImgName test container image name
	ContainerImgName string `json:"containerImgName"`
	// IsExecuteInHost indicates to run test command using chroot in case of container
	IsExecuteInHost bool `json:"isExecuteInHost"`
	// ContainerArgs test container arguments
	ContainerArgs string `json:"containerArgs"`
	// Command test command
	Command string `json:"command"`
	// Args test arguments
	Args string `json:"args"`
	// ExtraErrFile test command error output file
	ExtraErrFile string `json:"extraErrFile"`
	// ExternalConfigFile test external configuration file
	ExternalConfigFile string `json:"externalConfigFile"`
	// PreCondition test pre-condition
	PreCondition string `json:"preCondition"`
	// Timeout test timeout in seconds (default 7200)
	Timeout int64 `json:"timeout"`
	// ExtraOutputFile test command standard output file
	ExtraOutputFile string `json:"extraOutputFile"`
	// Version test version
	Version string `json:"version"`
	// SupportedPlatforms list of supported platform for a test
	SupportedPlatforms []string `json:"supportedPlatforms"`
	// ModifiedBy user that last modified test
	ModifiedBy string `json:"modifiedBy"`
	// IsVerified indicates if test verified or not
	IsVerified bool `json:"isVerified"`
	// ReadOnly indicates if the test is read-ony or not
	IsReadOnly bool `json:"isReadOnly"`
	// CustomTags list of custom tags for test
	CustomTags []string `json:"customTags"`
	// Components list of system components for test
	Components []string `json:"components"`
	// LastModifiedAt last time test modified
	LastModifiedAt string `json:"lastModifiedAt"`
	// IsEnabled indicates if test is enabled or not
	IsEnabled bool `json:"isEnabled"`
}

type APIMachineValidationTestCreateRequest struct {
	// Name test name
	Name string `json:"name"`
	// Command test command
	Command string `json:"command"`
	// Args test command arguments
	Args string `json:"args"`
	// Description test description
	Description *string `json:"description"`
	// Contexts list of contexts for a test
	Contexts []string `json:"contexts"`
	// ContainerImgName test container image name
	ContainerImgName *string `json:"containerImgName"`
	// ExecuteInHost run test command using chroot in case of container
	IsExecuteInHost *bool `json:"isExecuteInHost"`
	// ContainerArgs test container arguments
	ContainerArgs *string `json:"containerArgs"`
	// ExtraErrFile test command error output file
	ExtraErrFile *string `json:"extraErrFile"`
	// ExternalConfigFile test external configuration file
	ExternalConfigFile *string `json:"externalConfigFile"`
	// PreCondition test pre-condition
	PreCondition *string `json:"preCondition"`
	// Timeout test command timeout in seconds (default 7200)
	Timeout *int64 `json:"timeout"`
	// ExtraOutputFile test command standard output file
	ExtraOutputFile *string `json:"extraOutputFile"`
	// SupportedPlatforms list of supported platform for a test
	SupportedPlatforms []string `json:"supportedPlatforms"`
	// IsReadOnly indicates if test is read-only or not
	IsReadOnly *bool `json:"isReadOnly"`
	// CustomTags list of custom tags for a test
	CustomTags []string `json:"customTags"`
	// Components list of system components for a test
	Components []string `json:"components"`
	// IsEnabled indicates if test is enabled or not
	IsEnabled *bool `json:"isEnabled"`
}

type APIMachineValidationTestUpdateRequest struct {
	// Name test name
	Name *string `json:"name"`
	// Command test command
	Command *string `json:"command"`
	// Args test command arguments
	Args *string `json:"args"`
	// Description test description
	Description *string `json:"description"`
	// Contexts list of contexts for a test
	Contexts []string `json:"contexts"`
	// ContainerImgName test container image name
	ContainerImgName *string `json:"containerImgName"`
	// ExecuteInHost run test command using chroot in case of container
	IsExecuteInHost *bool `json:"isExecuteInHost"`
	// ContainerArgs test container arguments
	ContainerArgs *string `json:"containerArgs"`
	// ExtraErrFile test command error output file
	ExtraErrFile *string `json:"extraErrFile"`
	// ExternalConfigFile test external configuration file
	ExternalConfigFile *string `json:"externalConfigFile"`
	// PreCondition test pre-condition
	PreCondition *string `json:"preCondition"`
	// Timeout test command timeout in seconds (default 7200)
	Timeout *int64 `json:"timeout"`
	// ExtraOutputFile test command standard output file
	ExtraOutputFile *string `json:"extraOutputFile"`
	// SupportedPlatforms list of supported platform for a test
	SupportedPlatforms []string `json:"supportedPlatforms"`
	// IsVerified indicates if test verified or not
	IsVerified *bool `json:"isVerified"`
	// CustomTags list of custom tags for a test
	CustomTags []string `json:"customTags"`
	// Components list of system components for a test
	Components []string `json:"components"`
	// IsEnabled indicates if test is enabled or not
	IsEnabled *bool `json:"isEnabled"`
}

type APIMachineValidationTestsFilter struct {
	// SupportedPlatforms list of supported platform for a test
	SupportedPlatforms []string `query:"supportedPlatforms"`
	// Contexts list of contexts for a test
	Contexts []string `query:"contexts"`
	// IsReadOnly indicates if test is read-only or not
	IsReadOnly *bool `query:"isReadOnly"`
	// CustomTags list of custom tags for a test
	CustomTags []string `query:"customTags"`
	// IsEnabled indicates if test is enabled or not
	IsEnabled *bool `query:"isEnabled"`
	// IsVerified indicates if test verified or not
	IsVerified *bool `query:"isVerified"`
}

type APIMetadata struct {
	// Version contains the API version
	Version string `json:"version"`
	// BuildTime contains the time the binary was built
	BuildTime string `json:"buildTime"`
}

type APINVLinkInterface struct {
	// ID is the unique UUID v4 identifier for the NVLinkInterface
	ID string `json:"id"`
	// InstanceID is the ID of the associated Instance
	InstanceID string `json:"instanceId"`
	// Instance is the summary of the Instance
	Instance *APIInstanceSummary `json:"instance,omitempty"`
	// NVLinkLogicalPartitionID is the ID of the associated NVLinkLogicalPartition
	NVLinkLogicalPartitionID string `json:"nvLinklogicalPartitionId"`
	// NVLinkLogicalPartition is the summary of the NVLinkLogicalPartition
	NVLinkLogicalPartition *APINVLinkLogicalPartitionSummary `json:"nvLinkLogicalPartition,omitempty"`
	// NVLinkDomainID is the id of the physical NVLink domain that the interface is attached to
	NVLinkDomainID *string `json:"nvLinkDomainId"`
	// DeviceInstance is the index of the GPU
	DeviceInstance int `json:"deviceInstance"`
	// GpuGUID is the GUID of the GPU
	GpuGUID *string `json:"gpuGuid"`
	// Status is the status of the NVLinkInterface
	Status string `json:"status"`
	// Created is the date and time the entity was created
	Created time.Time `json:"created"`
	// Updated is the date and time the entity was last updated
	Updated time.Time `json:"updated"`
}

type APINVLinkInterfaceCreateOrUpdateRequest struct {
	// NVLinkLogicalPartitionID is the ID of the NVLinkLogicalPartition
	NVLinkLogicalPartitionID string `json:"nvLinkLogicalPartitionId"`
	// DeviceInstance is the index of the GPU
	DeviceInstance int `json:"deviceInstance"`
}

type APINVLinkInterfaceSummary struct {
	// ID of the NVLinkInterface
	ID string `json:"id"`
	// InstanceID is the ID of the Instance
	InstanceID string `json:"instanceId"`
	// NVLinkLogicalPartitionID is the ID of the NVLinkLogicalPartition
	NVLinkLogicalPartitionID string `json:"nvLinkLogicalPartitionId"`
	// DeviceInstance is the index of the GPU
	DeviceInstance int `json:"deviceInstance"`
	// Status is the status of the NVLinkInterface
	Status string `json:"status"`
}

type APINVLinkLogicalPartition struct {
	// ID is the unique UUID v4 identifier for the NVLinkLogicalPartition
	ID string `json:"id"`
	// Name is the name of the NVLinkLogicalPartition
	Name string `json:"name"`
	// Description is the description of the NVLinkLogicalPartition
	Description *string `json:"description"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// Tenant is the summary of the tenant
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// Vpcs is the list of VPCs associated with the NVLinkLogicalPartition
	Vpcs []APIVpcSummary `json:"vpcs,omitempty"`
	// NVLinkInterfaces is the list of NVLinkInterfaces associated with the NVLinkLogicalPartition
	NVLinkInterfaces []APINVLinkInterfaceSummary `json:"nvLinkInterfaces,omitempty"`
	// NVLinkLogicalPartitionStats holds GPU and instance counts for a NVLinkLogicalPartition
	NVLinkLogicalPartitionStats *APINVLinkLogicalPartitionStats `json:"nvLinkLogicalPartitionStats"`
	// Status is the status o the NVLinkLogicalPartition
	Status string `json:"status"`
	// StatusHistory is the status detail records for the NVLinkLogicalPartition over time
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// Created indicates the ISO datetime string for when the NVLinkLogicalPartition was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the NVLinkLogicalPartition was last updated
	Updated time.Time `json:"updated"`
}

type APINVLinkLogicalPartitionCreateRequest struct {
	// Name is the name of the NVLinkLogicalPartition
	Name string `json:"name"`
	// Description is the description of the NVLinkLogicalPartition
	Description *string `json:"description"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
}

type APINVLinkLogicalPartitionStats struct {
	TotalGpus              int `json:"totalGpus"`
	TotalDistinctInstances int `json:"totalDistinctInstances"`
}

type APINVLinkLogicalPartitionSummary struct {
	// ID of the NVLinkLogicalPartition
	ID string `json:"id"`
	// Name of the NVLinkLogicalPartition
	Name string `json:"name"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Status is the status of the NVLinkLogicalPartition
	Status string `json:"status"`
}

type APINVLinkLogicalPartitionUpdateRequest struct {
	// Name is the name of the NVLinkLogicalPartition
	Name *string `json:"name"`
	// Description is the description of the NVLinkLogicalPartition
	Description *string `json:"description"`
}

type APINetworkSecurityGroup struct {
	// ID is the unique UUID v4 identifier for the NetworkSecurityGroup
	ID string `json:"id"`
	// Name is the name of the NetworkSecurityGroup
	Name string `json:"name"`
	// Description is the description of the NetworkSecurityGroup
	Description *string `json:"description"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site,omitempty"`
	// TenantID is the ID of the Tenant
	TenantID string `json:"tenantId"`
	// Tenant is the summary of the tenant
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// Status is the status of the NetworkSecurityGroup
	Status string `json:"status"`
	// StatusHistory is the status detail records for the site over time
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// StatefulEgress defines whether a NetworkSecurityGroup's egress rules will be automatically stateful
	StatefulEgress bool `json:"statefulEgress"`
	// Rules is the list of NetworkSecurityGroupRuleAttributes for the NetworkSecurityGroup
	Rules []*APINetworkSecurityGroupRule `json:"rules"`
	// Labels is the set of labels/tags for the NetworkSecurityGroup
	Labels map[string]string `json:"labels"`
	// Created indicates the ISO datetime string for when the NetworkSecurityGroup was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the NetworkSecurityGroup was last updated
	Updated time.Time `json:"updated"`
	// AttachmentStats holds the counts for objects that have
	// Attached the NSG if requested.
	AttachmentStats *APINetworkSecurityGroupStats `json:"attachmentStats"`
	// RuleCount hold the count of the number of rules in the NetworkSecurityGroup
	RuleCount int `json:"ruleCount"`
}

type APINetworkSecurityGroupCreateRequest struct {
	// Name is the name of the NetworkSecurityGroup
	Name string `json:"name"`
	// Description is the description of the NetworkSecurityGroup
	Description *string `json:"description"`
	// SiteID is the ID of the Site
	SiteID string `json:"siteId"`
	// Rules is the list of NetworkSecurityGroupRuleAttributes for the NetworkSecurityGroup
	Rules []APINetworkSecurityGroupRule `json:"rules"`
	// StatefulEgress defines whether a NetworkSecurityGroup's egress rules will be automatically stateful
	StatefulEgress bool `json:"statefulEgress"`
	// Labels to be associted with the NetworkSecurityGroup
	Labels map[string]string `json:"labels"`
}

type APINetworkSecurityGroupPropagationDetails struct {
	// The ID of the object (VPC/Instance/etc) for these details
	ObjectID string `json:"object_id"`
	// The detailed propagation status that was
	// actually returned from Carbide
	DetailedStatus string `json:"detailedStatus"`
	// The simplified propagation status
	// that reduces the actual status to just
	// a few values.
	Status string `json:"status"`
	// Additional details for the status
	Details *string `json:"details"`
	// IDs of the instances involved in determining the
	// propagation status
	RelatedInstanceIds []string `json:"relatedInstanceIds"`
	// IDs of any instances associated with the ObjectID that have
	// not yet updated their NSG rules.
	UnpropagatedInstanceIds []string `json:"unpropagatedInstanceIds"`
}

type APINetworkSecurityGroupRule struct {
	Name                 *string `json:"name"`
	Direction            string  `json:"direction"`
	SourcePortRange      *string `json:"sourcePortRange"`
	DestinationPortRange *string `json:"destinationPortRange"`
	Protocol             string  `json:"protocol"`
	Action               string  `json:"action"`
	Priority             int     `json:"priority"`
	SourcePrefix         *string `json:"sourcePrefix"`
	DestinationPrefix    *string `json:"destinationPrefix"`
}

type APINetworkSecurityGroupStats struct {
	// InUse is a convenience field that will be true
	// if TotalAttachmentCount > 0
	InUse bool `json:"inUse"`
	// VpcAttachmentCount holds the count of the number of VPCs that have the NSG directly attached.
	VpcAttachmentCount int `json:"directVpcAttachmentCount"`
	// InstanceAttachmentCount holds the count of the number of instances that have the NSG directly attached.
	InstanceAttachmentCount int `json:"directInstanceAttachmentCount"`
	// TotalAttachmentCount holds the total count of all objects that have
	// the NSG directly attached.
	TotalAttachmentCount int `json:"totalDirectAttachmentCount"`
}

type APINetworkSecurityGroupSummary struct {
	// ID of the NetworkSecurityGroup
	ID string `json:"id"`
	// Name of the NetworkSecurityGroup
	Name string `json:"name"`
	// Description of the NetworkSecurityGroup
	Description *string `json:"description"`
	// Status is the status of the NetworkSecurityGroup
	Status string `json:"status"`
	// StatefulEgress defines whether a NetworkSecurityGroup's egress rules will be automatically stateful
	StatefulEgress bool `json:"statefulEgress"`
	// RuleCount hold the count of the number of rules in the NetworkSecurityGroup
	RuleCount int `json:"ruleCount"`
}

type APINetworkSecurityGroupUpdateRequest struct {
	// Name is the name of the NetworkSecurityGroup
	Name *string `json:"name"`
	// Description is the description of the NetworkSecurityGroup
	Description *string `json:"description"`
	// StatefulEgress defines whether a NetworkSecurityGroup's egress rules will be automatically stateful
	StatefulEgress *bool `json:"statefulEgress"`
	// Rules is the list of NetworkSecurityGroupRuleAttributes for the NetworkSecurityGroup
	Rules []APINetworkSecurityGroupRule `json:"rules"`
	// Labels to be associted with the NetworkSecurityGroup
	Labels map[string]string `json:"labels"`
}

type APIOperatingSystem struct {
	// ID is the unique UUID v4 identifier for the Operating System
	ID string `json:"id"`
	// Name is the name of the Operating System
	Name string `json:"name"`
	// Description is the description of the Operating System
	Description *string `json:"description"`
	// InfrastructureProviderID is the ID of the InfrastructureProvider creating the OS
	InfrastructureProviderID *string `json:"infrastructureProviderId"`
	// InfrastructureProvider is the summary of the InfrastructureProvider
	InfrastructureProvider *APIInfrastructureProviderSummary `json:"infrastructureProvider,omitempty"`
	// TenantID is the ID of the tenant creating the Operating System
	TenantID *string `json:"tenantId"`
	// Tenant is the summary of the Tenant
	Tenant *APITenantSummary `json:"tenant,omitempty"`
	// Type is which type of Operating System
	Type *string `json:"type"`
	// ImageUrl is url path for the Operating System
	ImageURL *string `json:"imageUrl"`
	// ImageSHA is SHA for the Operating System image type
	ImageSHA *string `json:"imageSha"`
	// ImageAuthType is auth type for the Operating System type
	ImageAuthType *string `json:"imageAuthType"`
	// ImageAuthToken is auth token for for the Operating System image type
	ImageAuthToken *string `json:"imageAuthToken"`
	// ImageDisk is disk for the Operating System image type
	ImageDisk *string `json:"imageDisk"`
	// RootFsID is root fs id for the Operating System image type
	RootFsID *string `json:"rootFsId"`
	// RootFsLabel is root fs id for the Operating System image type
	RootFsLabel *string `json:"rootFsLabel"`
	// IpxeScript is the ipxe ocript for the Operating System
	IpxeScript *string `json:"ipxeScript"`
	// PhoneHomeEnabled is an attribute which is specified by user if Operating System needs to be enabled for phone home or not
	PhoneHomeEnabled bool `json:"phoneHomeEnabled"`
	// UserData is the user data for the Operating System
	UserData *string `json:"userData"`
	// IsCloudInit indicates if the Operating System needs cloud init
	IsCloudInit bool `json:"isCloudInit"`
	// AllowOverride indicates if overrides are allowed
	AllowOverride bool `json:"allowOverride"`
	// EnableBlockStorage indicates whether the Operating System image will be stored remotely via block storage
	EnableBlockStorage bool `json:"enableBlockStorage"`
	// IsActive indicates if the Operating System is active
	IsActive bool `json:"isActive"`
	// DeactivationNote is the deactivation note if any
	DeactivationNote *string `json:"deactivationNote"`
	// Status is the status of the Operating System
	Status string `json:"status"`
	// StatusHistory is the history of statuses for the Operating System
	StatusHistory []APIStatusDetail `json:"statusHistory"`
	// SiteAssociations is the list of Sites associated with the Operating System
	SiteAssociations []APIOperatingSystemSiteAssociation `json:"siteAssociations"`
	// CreatedAt indicates the ISO datetime string for when the entity was created
	Created time.Time `json:"created"`
	// UpdatedAt indicates the ISO datetime string for when the entity was last updated
	Updated time.Time `json:"updated"`
}

type APIOperatingSystemCreateRequest struct {
	// Name is the name of the OperatingSystem
	Name string `json:"name"`
	// Description is the description of the OperatingSystem
	Description *string `json:"description"`
	// InfrastructureProviderID is the ID of the InfrastructureProvider creating the Operating System
	InfrastructureProviderID *string `json:"infrastructureProviderId"`
	// SiteIDs is a list of Site objects
	SiteIDs []string `json:"siteIds"`
	// TenantID is the ID of the Tenant creating the Operating System
	TenantID *string `json:"tenantId"`
	// IpxeScript is the iPXE script for the Operating System
	IpxeScript *string `json:"ipxeScript"`
	// ImageURL is the image path for the Operating System
	ImageURL *string `json:"imageUrl"`
	// ImageSHA is SHA for the Operating System image type
	ImageSHA *string `json:"imageSha"`
	// ImageAuthType is auth type for the Operating System type
	ImageAuthType *string `json:"imageAuthType"`
	// ImageAuthToken is auth token for for the Operating System image type
	ImageAuthToken *string `json:"imageAuthToken"`
	// ImageDisk is disk for the Operating System image type
	ImageDisk *string `json:"imageDisk"`
	// RootFsID is root fs id for the Operating System image type
	RootFsID *string `json:"rootFsId"`
	// RootFsLabel is root fs label for the Operating System image type
	RootFsLabel *string `json:"rootFsLabel"`
	// PhoneHomeEnabled is the flag to allow enable phone home
	PhoneHomeEnabled *bool `json:"phoneHomeEnabled"`
	// UserData is the user data for the Operating System
	UserData *string `json:"userData"`
	// IsCloudInit indicates if the Operating System needs cloud init
	IsCloudInit bool `json:"isCloudInit"`
	// AllowOverride indicates if overrides are allowed
	AllowOverride bool `json:"allowOverride"`
	// EnableBlockStorage indicates whether the Operating System image will be stored remotely via block storage
	EnableBlockStorage bool `json:"enableBlockStorage"`
}

type APIOperatingSystemSiteAssociation struct {
	// Site is the summary of the Site
	Site *APISiteSummary `json:"site"`
	// Version is the version of corresponding image on Site
	Version *string `json:"version"`
	// Status is the status of the OperatingSystemSiteAssociation
	Status string `json:"status"`
	// Created indicates the ISO datetime string for when the site was created
	Created time.Time `json:"created"`
	// Updated indicates the ISO datetime string for when the site was last updated
	Updated time.Time `json:"updated"`
}

type APIOperatingSystemSummary struct {
	// ID of the OperatingSystem
	ID string `json:"id"`
	// Name of the OperatingSystem, only lowercase characters, digits, hyphens and cannot begin/end with hyphen
	Name string `json:"name"`
	// Type is which type of Operating System
	Type *string `json:"type"`
	// Status is the status of the Operating System
	Status string `json:"status"`
}

type APIOperatingSystemUpdateRequest struct {
	// Name is the name of the OperatingSystem
	Name *string `json:"name"`
	// Description is the description of the Operating System
	Description *string `json:"description"`
	// IpxeScript is the ipxe script for the Operating System
	IpxeScript *string `json:"ipxeScript"`
	// ImageURL is the image path for the Operating System
	ImageURL *string `json:"imageUrl"`
	// ImageSHA is SHA for the Operating System image type
	ImageSHA *string `json:"imageSha"`
	// ImageAuthType is auth type for the Operating System type
	ImageAuthType *string `json:"imageAuthType"`
	// ImageAuthToken is auth token for for the Operating System image type
	ImageAuthToken *string `json:"imageAuthToken"`
	// ImageDisk is disk for the Operating System image type
	ImageDisk *string `json:"imageDisk"`
	// RootFsID is root fs id for the Operating System image type
	RootFsID *string `json:"rootFsId"`
	// RootFsLabel is root fs label for the Operating System image type
	RootFsLabel *string `json:"rootFsLabel"`
	// PhoneHomeEnabled is the flag to allow enable phone home
	PhoneHomeEnabled *bool `json:"phoneHomeEnabled"`
	// UserData is the user data for the Operating System
	UserData *string `json:"userData"`
	// IsCloudInit indicates if the Operating System needs cloud init
	IsCloudInit *bool `json:"isCloudInit"`
	// AllowOverride indicates if overrides are allowed
	AllowOverride *bool `json:"allowOverride"`
	// IsActive indicates if the Operating System is active
	IsActive *bool `json:"isActive"`
	// DeactivationNote is the deactivation note if any
	DeactivationNote *string `json:"deactivationNote"`
}

type APIRack struct {
	ID           string              `json:"id"`
	Name         string              `json:"name"`
	Manufacturer string              `json:"manufacturer"`
	Model        string              `json:"model"`
	SerialNumber string              `json:"serialNumber"`
	Description  string              `json:"description"`
	Location     *APIRackLocation    `json:"location,omitempty"`
	Components   []*APIRackComponent `json:"components,omitempty"`
}