Documentation
¶
Index ¶
- Constants
- func AttachVpcNsgPropagationDetailsToApiInstance(c echo.Context, ctx context.Context, logger *zerolog.Logger, ...) error
- func ValidateProviderOrTenantSiteAccess(ctx context.Context, logger zerolog.Logger, dbSession *cdb.Session, ...) (bool, *cutil.APIError)
- type AdvanceTaskRunPhaseHandler
- type BatchBringUpRackHandler
- type BatchCreateInstanceHandler
- type BatchUpdateNVLinkDomainFirmwareHandler
- type BatchUpdateNVLinkDomainPowerStateHandler
- type BatchUpdateRackFirmwareHandler
- type BatchUpdateRackPowerStateHandler
- type BatchUpdateTrayFirmwareHandler
- type BatchUpdateTrayPowerStateHandler
- type BringUpRackHandler
- type CancelTaskHandler
- type CancelTaskRunHandler
- type CreateAllocationHandler
- type CreateDpuExtensionServiceHandler
- type CreateExpectedMachineHandler
- type CreateExpectedMachinesHandler
- type CreateExpectedPowerShelfHandler
- type CreateExpectedRackGroupHandler
- type CreateExpectedRackHandler
- type CreateExpectedSwitchHandler
- type CreateIPBlockHandler
- type CreateInfiniBandPartitionHandler
- type CreateInfrastructureProviderHandler
- type CreateInstanceHandler
- type CreateInstanceTypeHandler
- type CreateMachineInstanceTypeHandler
- type CreateMachineValidationExternalConfigHandler
- type CreateMachineValidationRunHandler
- type CreateMachineValidationTestHandler
- type CreateMeasuredBootTrustedMachineHandler
- type CreateMeasuredBootTrustedProfileHandler
- type CreateNVLinkLogicalPartitionHandler
- type CreateNetworkSecurityGroupHandler
- type CreateOperatingSystemHandler
- type CreateOrUpdateBMCCredentialHandler
- type CreateOrUpdateHostFirmwareConfigHandler
- type CreateOrUpdateMachineHealthReportHandler
- type CreateOrUpdateRackHealthReportHandler
- type CreateOrUpdateTenantIdentityConfigHandler
- type CreateOrUpdateTenantIdentityTokenDelegationHandler
- type CreateOrUpdateTrayHealthReportHandler
- type CreateSSHKeyGroupHandler
- type CreateSSHKeyHandler
- type CreateSiteHandler
- type CreateSkuHandler
- type CreateSpectrumXPartitionHandler
- type CreateSubnetHandler
- type CreateTaskRuleHandler
- type CreateTaskRunHandler
- type CreateTenantAccountHandler
- type CreateTenantHandler
- type CreateUEFICredentialHandler
- type CreateVPCHandler
- type CreateVpcPeeringHandler
- type CreateVpcPrefixHandler
- type DecommissionMachineHandler
- type DecommissionTrayHandler
- type DeleteAllExpectedMachinesHandler
- type DeleteAllExpectedPowerShelvesHandler
- type DeleteAllExpectedRackGroupsHandler
- type DeleteAllExpectedRacksHandler
- type DeleteAllExpectedSwitchesHandler
- type DeleteAllocationHandler
- type DeleteDpuExtensionServiceHandler
- type DeleteDpuExtensionServiceVersionHandler
- type DeleteExpectedMachineHandler
- type DeleteExpectedPowerShelfHandler
- type DeleteExpectedRackGroupHandler
- type DeleteExpectedRackHandler
- type DeleteExpectedSwitchHandler
- type DeleteHostFirmwareConfigHandler
- type DeleteIPBlockHandler
- type DeleteInfiniBandPartitionHandler
- type DeleteInstanceHandler
- type DeleteInstanceTypeHandler
- type DeleteMachineHandler
- type DeleteMachineHealthReportHandler
- type DeleteMachineInstanceTypeHandler
- type DeleteMachineValidationExternalConfigHandler
- type DeleteMeasuredBootTrustedMachineHandler
- type DeleteMeasuredBootTrustedProfileHandler
- type DeleteNVLinkLogicalPartitionHandler
- type DeleteNetworkSecurityGroupHandler
- type DeleteOperatingSystemHandler
- type DeleteRackHealthReportHandler
- type DeleteSSHKeyGroupHandler
- type DeleteSSHKeyHandler
- type DeleteSiteHandler
- type DeleteSkuHandler
- type DeleteSpectrumXPartitionHandler
- type DeleteSubnetHandler
- type DeleteTaskRuleHandler
- type DeleteTenantAccountHandler
- type DeleteTenantIdentityConfigHandler
- type DeleteTenantIdentityTokenDelegationHandler
- type DeleteTrayHealthReportHandler
- type DeleteVPCHandler
- type DeleteVpcPeeringHandler
- type DeleteVpcPrefixHandler
- type FactoryResetHandler
- type GetAllAllocationHandler
- type GetAllAuditEntryHandler
- type GetAllDerivedIPBlockHandler
- type GetAllDpuExtensionServiceHandler
- type GetAllDpuMachineHandler
- type GetAllDpuMachinesHandler
- type GetAllExpectedMachineHandler
- type GetAllExpectedMachineLabelKeyHandler
- type GetAllExpectedMachineLabelValueHandler
- type GetAllExpectedPowerShelfHandler
- type GetAllExpectedRackGroupHandler
- type GetAllExpectedRackHandler
- type GetAllExpectedSwitchHandler
- type GetAllExploredEndpointHandler
- type GetAllFabricHandler
- type GetAllIPBlockHandler
- type GetAllInfiniBandInterfaceHandler
- type GetAllInfiniBandPartitionHandler
- type GetAllInstanceHandler
- type GetAllInstanceInfiniBandInterfaceHandler
- type GetAllInstanceInterfaceHandler
- type GetAllInstanceNVLinkInterfaceHandler
- type GetAllInstanceTypeHandler
- type GetAllInterfaceHandler
- type GetAllIpxeTemplateHandler
- type GetAllMachineCapabilityHandler
- type GetAllMachineHandler
- type GetAllMachineHealthReportHandler
- type GetAllMachineInstanceTypeHandler
- type GetAllMachineLabelKeyHandler
- type GetAllMachineLabelValueHandler
- type GetAllMachineValidationExternalConfigHandler
- type GetAllMachineValidationRunHandler
- type GetAllMachineValidationTestHandler
- type GetAllMeasuredBootTrustedMachineHandler
- type GetAllMeasuredBootTrustedProfileHandler
- type GetAllNVLinkDomainHandler
- type GetAllNVLinkInterfaceHandler
- type GetAllNVLinkLogicalPartitionHandler
- type GetAllNetworkSecurityGroupHandler
- type GetAllOperatingSystemHandler
- type GetAllRackHandler
- type GetAllRackHealthReportHandler
- type GetAllSSHKeyGroupHandler
- type GetAllSSHKeyHandler
- type GetAllSiteHandler
- type GetAllSkuHandler
- type GetAllSpectrumXPartitionHandler
- type GetAllSubnetHandler
- type GetAllTaskHandler
- type GetAllTaskRuleHandler
- type GetAllTaskRunHandler
- type GetAllTaskRunTargetHandler
- type GetAllTenantAccountHandler
- type GetAllTrayHandler
- type GetAllTrayHealthReportHandler
- type GetAllVPCHandler
- type GetAllVpcPeeringHandler
- type GetAllVpcPrefixHandler
- type GetAllocationHandler
- type GetAuditEntryHandler
- type GetCredentialRotationStatusHandler
- type GetCurrentInfrastructureProviderHandler
- type GetCurrentInfrastructureProviderStatsHandler
- type GetCurrentServiceAccountHandler
- type GetCurrentTenantHandler
- type GetCurrentTenantRoutingProfileHandler
- type GetCurrentTenantStatsHandler
- type GetDpuExtensionServiceHandler
- type GetDpuExtensionServiceVersionHandler
- type GetDpuMachineHandler
- type GetExpectedMachineHandler
- type GetExpectedPowerShelfHandler
- type GetExpectedRackGroupHandler
- type GetExpectedRackHandler
- type GetExpectedSwitchHandler
- type GetFabricHandler
- type GetIPBlockHandler
- type GetInfiniBandPartitionHandler
- type GetInstanceHandler
- type GetInstanceStatusDetailsHandler
- type GetInstanceTypeHandler
- type GetIpxeTemplateHandler
- type GetJWKSHandler
- type GetMachineGPUStatsHandler
- type GetMachineHandler
- type GetMachineInstanceTypeStatsHandler
- type GetMachineInstanceTypeSummaryHandler
- type GetMachineSpectrumXMultiplaneHandler
- type GetMachineStatusDetailsHandler
- type GetMachineValidationExternalConfigHandler
- type GetMachineValidationResultsHandler
- type GetMachineValidationTestHandler
- type GetNVLinkDomainHandler
- type GetNVLinkLogicalPartitionHandler
- type GetNetworkSecurityGroupHandler
- type GetOpenIDConfigurationHandler
- type GetOperatingSystemHandler
- type GetRackHandler
- type GetRackPowerStateHandler
- type GetRackTasksHandler
- type GetSSHKeyGroupHandler
- type GetSSHKeyHandler
- type GetSiteHandler
- type GetSiteStatusDetailsHandler
- type GetSkuHandler
- type GetSpectrumXPartitionHandler
- type GetSubnetHandler
- type GetTaskHandler
- type GetTaskRuleHandler
- type GetTaskRunHandler
- type GetTenantAccountHandler
- type GetTenantIdentityConfigHandler
- type GetTenantIdentityTokenDelegationHandler
- type GetTenantInstanceTypeStatsHandler
- type GetTrayHandler
- type GetTrayPowerStateHandler
- type GetTrayTasksHandler
- type GetUserHandler
- type GetVPCHandler
- type GetVPCRoutingProfileHandler
- type GetVpcPeeringHandler
- type GetVpcPrefixHandler
- type HealthCheckHandler
- type MachinePowerControlHandler
- type MetadataHandler
- type PauseTaskRunHandler
- type ReadinessCheckHandler
- type ReencryptTenantIdentitySecretsHandler
- type ReleaseVPCInactiveVniHandler
- type ReplaceAllExpectedMachinesHandler
- type ReplaceAllExpectedPowerShelvesHandler
- type ReplaceAllExpectedRackGroupsHandler
- type ReplaceAllExpectedRacksHandler
- type ReplaceAllExpectedSwitchesHandler
- type ReprovisionMachineDpuHandler
- type ResetMachineBMCHandler
- type ResetMachineChassisHandler
- type ResumeTaskRunHandler
- type RotateCredentialHandler
- type SiteExplorerEndpointActionHandler
- type UpdateAllocationConstraintHandler
- type UpdateAllocationHandler
- type UpdateCurrentInfrastructureProviderHandler
- type UpdateCurrentTenantHandler
- type UpdateDpuExtensionServiceHandler
- type UpdateExpectedMachineHandler
- type UpdateExpectedMachinesHandler
- type UpdateExpectedPowerShelfHandler
- type UpdateExpectedRackGroupHandler
- type UpdateExpectedRackHandler
- type UpdateExpectedSwitchHandler
- type UpdateIPBlockHandler
- type UpdateInfiniBandPartitionHandler
- type UpdateInstanceHandler
- type UpdateInstanceTypeHandler
- type UpdateMachineHandler
- type UpdateMachineSpectrumXMultiplaneHandler
- type UpdateMachineValidationExternalConfigHandler
- type UpdateMachineValidationTestHandler
- type UpdateNVLinkDomainFirmwareHandler
- type UpdateNVLinkDomainPowerStateHandler
- type UpdateNVLinkLogicalPartitionHandler
- type UpdateNetworkSecurityGroupHandler
- type UpdateOperatingSystemHandler
- type UpdateRackFirmwareHandler
- type UpdateRackPowerStateHandler
- type UpdateSSHKeyGroupHandler
- type UpdateSSHKeyHandler
- type UpdateSiteHandler
- type UpdateSkuHandler
- type UpdateSubnetHandler
- type UpdateTaskRuleHandler
- type UpdateTenantAccountHandler
- type UpdateTrayFirmwareHandler
- type UpdateTrayPowerStateHandler
- type UpdateVPCHandler
- type UpdateVPCRoutingProfileHandler
- type UpdateVPCVirtualizationHandler
- type UpdateVpcPrefixHandler
- type ValidateRackHandler
- type ValidateRacksHandler
- type ValidateTrayHandler
- type ValidateTraysHandler
Constants ¶
const ( NVLinkInterfaceStatusSyncGraceWindow = 90 * time.Second InfiniBandInterfaceStatusSyncGraceWindow = 90 * time.Second )
const ( // SiteRegistrationTokenValidityPeriod is the duration after which a Site registration token expires SiteRegistrationTokenValidityPeriod = time.Hour * 24 * 2 // SiteWorkflowRetentionPeriod is the duration after which completed Site workflows are expunged SiteWorkflowRetentionPeriod = time.Hour * 24 * 7 )
const DefaultReservedIPCount = 2
const MachineMissingDelayThreshold = 24 * time.Hour
Variables ¶
This section is empty.
Functions ¶
func AttachVpcNsgPropagationDetailsToApiInstance ¶
func AttachVpcNsgPropagationDetailsToApiInstance(c echo.Context, ctx context.Context, logger *zerolog.Logger, dbSession *cdb.Session, instance *cdbm.Instance, interfaces []cdbm.Interface, apiInstance *model.APIInstance) error
AttachVpcNsgPropagationDetailsToApiInstance attaches NSG propagation details to an APIInstance. It returns NewAPIErrorResponse directly.
func ValidateProviderOrTenantSiteAccess ¶
func ValidateProviderOrTenantSiteAccess(ctx context.Context, logger zerolog.Logger, dbSession *cdb.Session, site *cdbm.Site, infrastructureProvider *cdbm.InfrastructureProvider, tenant *cdbm.Tenant) (bool, *cutil.APIError)
ValidateProviderOrTenantSiteAccess validates if the provider or tenant has access to the site
Types ¶
type AdvanceTaskRunPhaseHandler ¶
type AdvanceTaskRunPhaseHandler struct {
// contains filtered or unexported fields
}
AdvanceTaskRunPhaseHandler opens the next phase of a phase-gated Run.
func NewAdvanceTaskRunPhaseHandler ¶
func NewAdvanceTaskRunPhaseHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) AdvanceTaskRunPhaseHandler
NewAdvanceTaskRunPhaseHandler initializes a new AdvanceTaskRunPhaseHandler.
func (AdvanceTaskRunPhaseHandler) Handle ¶
func (h AdvanceTaskRunPhaseHandler) Handle(c echo.Context) error
Handle godoc @Summary Advance a Run to its next phase @Description Open the next phase of a Run paused at a phase gate. Optionally guard with expectedPhaseIndex so a stale client cannot advance the wrong phase. @Tags run @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Run" @Param body body model.APITaskRunAdvanceRequest true "Advance run request" @Success 202 {object} model.APITaskRun @Router /v2/org/{org}/nico/task/run/{id}/advance [post]
type BatchBringUpRackHandler ¶
type BatchBringUpRackHandler struct {
// contains filtered or unexported fields
}
BatchBringUpRackHandler is the API Handler for bringing up explicitly named Racks.
func NewBatchBringUpRackHandler ¶
func NewBatchBringUpRackHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) BatchBringUpRackHandler
NewBatchBringUpRackHandler initializes and returns a new handler for batch bringing up Racks
func (BatchBringUpRackHandler) Handle ¶
func (bbuh BatchBringUpRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Bring up Racks @Description Bring up explicitly named Racks. Provide a nonempty filter.names list. @Description An omitted, null, or empty filter, including an empty names list, is rejected before task creation. @Description For a site-wide operation, list every intended rack. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APIBatchBringUpRackRequest true "Batch rack bring up request" @Success 200 {object} model.APIBringUpRackResponse @Router /v2/org/{org}/nico/rack/bringup [post]
type BatchCreateInstanceHandler ¶
type BatchCreateInstanceHandler struct {
// contains filtered or unexported fields
}
BatchCreateInstanceHandler is the API Handler for creating multiple instances with topology-optimized allocation
func NewBatchCreateInstanceHandler ¶
func NewBatchCreateInstanceHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config, dps dpsclient.PowerProvisioner) BatchCreateInstanceHandler
NewBatchCreateInstanceHandler initializes and returns a new handler for batch creating Instances
func (BatchCreateInstanceHandler) Handle ¶
func (bcih BatchCreateInstanceHandler) Handle(c echo.Context) error
Handle godoc @Summary Batch create multiple Instances with topology-optimized allocation @Description Create multiple Instances with topology-optimized machine allocation. If topologyOptimized is true, all instances must be allocated on the same rack/topology domain (e.g., for NVLink). If false, instances can be spread across racks. @Tags Instance @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIBatchInstanceCreateRequest true "Batch instance creation request" @Success 201 {object} []model.APIInstance @Router /v2/org/{org}/nico/instance/batch [post]
type BatchUpdateNVLinkDomainFirmwareHandler ¶
type BatchUpdateNVLinkDomainFirmwareHandler struct {
// contains filtered or unexported fields
}
BatchUpdateNVLinkDomainFirmwareHandler updates firmware on one or more NVLink Domains.
func NewBatchUpdateNVLinkDomainFirmwareHandler ¶
func NewBatchUpdateNVLinkDomainFirmwareHandler( dbSession *cdb.Session, scp *sc.ClientPool, ) BatchUpdateNVLinkDomainFirmwareHandler
NewBatchUpdateNVLinkDomainFirmwareHandler initializes a batch NVLink Domain firmware-update handler.
func (BatchUpdateNVLinkDomainFirmwareHandler) Handle ¶
func (h BatchUpdateNVLinkDomainFirmwareHandler) Handle(c echo.Context) error
Handle godoc @Summary Firmware update NVLink Domains @Description Update firmware on one or more NVLink Domains identified by ID. @Tags domain @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APIBatchNVLinkDomainFirmwareUpdateRequest true "Batch NVLink Domain firmware update request" @Success 200 {object} model.APIUpdateFirmwareResponse @Router /v2/org/{org}/nico/domain/nvlink/firmware [patch]
type BatchUpdateNVLinkDomainPowerStateHandler ¶
type BatchUpdateNVLinkDomainPowerStateHandler struct {
// contains filtered or unexported fields
}
BatchUpdateNVLinkDomainPowerStateHandler power controls one or more NVLink Domains.
func NewBatchUpdateNVLinkDomainPowerStateHandler ¶
func NewBatchUpdateNVLinkDomainPowerStateHandler( dbSession *cdb.Session, scp *sc.ClientPool, ) BatchUpdateNVLinkDomainPowerStateHandler
NewBatchUpdateNVLinkDomainPowerStateHandler initializes a batch NVLink Domain power-control handler.
func (BatchUpdateNVLinkDomainPowerStateHandler) Handle ¶
func (h BatchUpdateNVLinkDomainPowerStateHandler) Handle(c echo.Context) error
Handle godoc @Summary Power control NVLink Domains @Description Power control one or more NVLink Domains identified by ID. @Tags domain @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APIBatchUpdateNVLinkDomainPowerStateRequest true "Batch NVLink Domain power control request" @Success 200 {object} model.APIUpdatePowerStateResponse @Router /v2/org/{org}/nico/domain/nvlink/power [patch]
type BatchUpdateRackFirmwareHandler ¶
type BatchUpdateRackFirmwareHandler struct {
// contains filtered or unexported fields
}
BatchUpdateRackFirmwareHandler is the API Handler for firmware upgrading explicitly named Racks.
func NewBatchUpdateRackFirmwareHandler ¶
func NewBatchUpdateRackFirmwareHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) BatchUpdateRackFirmwareHandler
NewBatchUpdateRackFirmwareHandler initializes and returns a new handler for batch firmware upgrading Racks
func (BatchUpdateRackFirmwareHandler) Handle ¶
func (furbh BatchUpdateRackFirmwareHandler) Handle(c echo.Context) error
Handle godoc @Summary Firmware update Racks @Description Update firmware on explicitly named Racks. Provide a nonempty filter.names list. @Description An omitted, null, or empty filter, including an empty names list, is rejected before task creation. @Description For a site-wide update, list every intended rack. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APIBatchRackFirmwareUpdateRequest true "Batch rack firmware update request" @Success 200 {object} model.APIUpdateFirmwareResponse @Router /v2/org/{org}/nico/rack/firmware [patch]
type BatchUpdateRackPowerStateHandler ¶
type BatchUpdateRackPowerStateHandler struct {
// contains filtered or unexported fields
}
BatchUpdateRackPowerStateHandler is the API Handler for power controlling explicitly named Racks.
func NewBatchUpdateRackPowerStateHandler ¶
func NewBatchUpdateRackPowerStateHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) BatchUpdateRackPowerStateHandler
NewBatchUpdateRackPowerStateHandler initializes and returns a new handler for batch power controlling Racks
func (BatchUpdateRackPowerStateHandler) Handle ¶
func (pcrbh BatchUpdateRackPowerStateHandler) Handle(c echo.Context) error
Handle godoc @Summary Power control Racks @Description Power control explicitly named Racks (On, Off, Cycle, ForceOff, ForceCycle, ACPowerCycle). Provide a nonempty filter.names list. @Description An omitted, null, or empty filter, including an empty names list, is rejected before task creation. @Description For a site-wide operation, list every intended rack. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APIBatchUpdateRackPowerStateRequest true "Batch rack power control request" @Success 200 {object} model.APIUpdatePowerStateResponse @Router /v2/org/{org}/nico/rack/power [patch]
type BatchUpdateTrayFirmwareHandler ¶
type BatchUpdateTrayFirmwareHandler struct {
// contains filtered or unexported fields
}
BatchUpdateTrayFirmwareHandler is the API Handler for firmware upgrading Trays with optional filters
func NewBatchUpdateTrayFirmwareHandler ¶
func NewBatchUpdateTrayFirmwareHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) BatchUpdateTrayFirmwareHandler
NewBatchUpdateTrayFirmwareHandler initializes and returns a new handler for batch firmware upgrading Trays
func (BatchUpdateTrayFirmwareHandler) Handle ¶
func (futbh BatchUpdateTrayFirmwareHandler) Handle(c echo.Context) error
Handle godoc @Summary Firmware update Trays @Description Update firmware on Trays with optional filters. If no filter is specified, targets all trays in the Site. @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APIBatchTrayFirmwareUpdateRequest true "Batch tray firmware update request" @Success 200 {object} model.APIUpdateFirmwareResponse @Router /v2/org/{org}/nico/tray/firmware [patch]
type BatchUpdateTrayPowerStateHandler ¶
type BatchUpdateTrayPowerStateHandler struct {
// contains filtered or unexported fields
}
BatchUpdateTrayPowerStateHandler is the API Handler for power controlling Trays with optional filters
func NewBatchUpdateTrayPowerStateHandler ¶
func NewBatchUpdateTrayPowerStateHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) BatchUpdateTrayPowerStateHandler
NewBatchUpdateTrayPowerStateHandler initializes and returns a new handler for batch power controlling Trays
func (BatchUpdateTrayPowerStateHandler) Handle ¶
func (pctbh BatchUpdateTrayPowerStateHandler) Handle(c echo.Context) error
Handle godoc @Summary Power control Trays @Description Power control Trays with optional filters (On, Off, Cycle, ForceOff, ForceCycle, ACPowerCycle). If no filter is specified, targets all trays in the Site. @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APIBatchUpdateTrayPowerStateRequest true "Batch tray power control request" @Success 200 {object} model.APIUpdatePowerStateResponse @Router /v2/org/{org}/nico/tray/power [patch]
type BringUpRackHandler ¶
type BringUpRackHandler struct {
// contains filtered or unexported fields
}
BringUpRackHandler is the API Handler for bringing up a single Rack by ID
func NewBringUpRackHandler ¶
func NewBringUpRackHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) BringUpRackHandler
NewBringUpRackHandler initializes and returns a new handler for bringing up a Rack
func (BringUpRackHandler) Handle ¶
func (burh BringUpRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Bring up a Rack @Description Bring up a Rack identified by Rack ID @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "Rack ID" @Param body body model.APIBringUpRackRequest true "Bring up request" @Success 200 {object} model.APIBringUpRackResponse @Router /v2/org/{org}/nico/rack/{id}/bringup [post]
type CancelTaskHandler ¶
type CancelTaskHandler struct {
// contains filtered or unexported fields
}
CancelTaskHandler is the API Handler for cancelling a Task by ID.
Cancellation is best-effort and idempotent: tasks in non-terminal states (Pending, Running, Waiting) are marked Terminated and any underlying Temporal workflow is terminated. Already-Terminated tasks are returned unchanged. Tasks that have already finished (Succeeded or Failed) cannot be cancelled and yield an error from Flow. The handler returns 202 Accepted with the task as last reported by Flow.
func NewCancelTaskHandler ¶
func NewCancelTaskHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) CancelTaskHandler
NewCancelTaskHandler initializes and returns a new handler for cancelling a Task
func (CancelTaskHandler) Handle ¶
func (cth CancelTaskHandler) Handle(c echo.Context) error
Handle godoc @Summary Cancel a Task @Description Cancel a Task by UUID. Best-effort and idempotent. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Task" @Param body body model.APICancelTaskRequest true "Cancel task request" @Success 202 {object} model.APITask @Router /v2/org/{org}/nico/rack/task/{id}/cancel [post]
type CancelTaskRunHandler ¶
type CancelTaskRunHandler struct {
// contains filtered or unexported fields
}
CancelTaskRunHandler cancels a Run and its in-flight targets.
func NewCancelTaskRunHandler ¶
func NewCancelTaskRunHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) CancelTaskRunHandler
NewCancelTaskRunHandler initializes a new CancelTaskRunHandler.
func (CancelTaskRunHandler) Handle ¶
func (h CancelTaskRunHandler) Handle(c echo.Context) error
Handle godoc @Summary Cancel a Run @Description Cancel a Run. Best-effort cancellation cascades to the current phase's in-flight target tasks. @Tags run @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Run" @Param body body model.APITaskRunCancelRequest true "Cancel run request" @Success 202 {object} model.APITaskRun @Router /v2/org/{org}/nico/task/run/{id}/cancel [post]
type CreateAllocationHandler ¶
type CreateAllocationHandler struct {
// contains filtered or unexported fields
}
CreateAllocationHandler is the API Handler for creating a new Allocatio n
func NewCreateAllocationHandler ¶
func NewCreateAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateAllocationHandler
NewCreateAllocationHandler initializes and returns a new handler for creating Allocation
func (CreateAllocationHandler) Handle ¶
func (cah CreateAllocationHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an Allocation @Description Create an Allocation @Tags Allocation @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIAllocationCreateRequest true "Allocation creation request" @Success 201 {object} model.APIAllocation @Router /v2/org/{org}/nico/allocation [post]
type CreateDpuExtensionServiceHandler ¶
type CreateDpuExtensionServiceHandler struct {
// contains filtered or unexported fields
}
CreateDpuExtensionServiceHandler is the API Handler for creating new DPU Extension Service
func NewCreateDpuExtensionServiceHandler ¶
func NewCreateDpuExtensionServiceHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) CreateDpuExtensionServiceHandler
NewCreateDpuExtensionServiceHandler initializes and returns a new handler for creating DPU Extension Service
func (CreateDpuExtensionServiceHandler) Handle ¶
func (cdesh CreateDpuExtensionServiceHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a DPU Extension Service @Description Create a DPU Extension Service for the current Tenant @Tags DPU Extension Service @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIDpuExtensionServiceCreateRequest true "DPU Extension Service creation request" @Success 201 {object} model.APIDpuExtensionService @Router /v2/org/{org}/nico/dpu-extension-service [post]
type CreateExpectedMachineHandler ¶
type CreateExpectedMachineHandler struct {
// contains filtered or unexported fields
}
CreateExpectedMachineHandler is the API Handler for creating new ExpectedMachine
func NewCreateExpectedMachineHandler ¶
func NewCreateExpectedMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateExpectedMachineHandler
NewCreateExpectedMachineHandler initializes and returns a new handler for creating ExpectedMachine
func (CreateExpectedMachineHandler) Handle ¶
func (cemh CreateExpectedMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an ExpectedMachine @Description Create an ExpectedMachine @Tags ExpectedMachine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIExpectedMachineCreateRequest true "ExpectedMachine creation request" @Success 201 {object} model.APIExpectedMachine @Router /v2/org/{org}/nico/expected-machine [post]
type CreateExpectedMachinesHandler ¶
type CreateExpectedMachinesHandler struct {
// contains filtered or unexported fields
}
CreateExpectedMachinesHandler is the API Handler for creating multiple ExpectedMachines
func NewCreateExpectedMachinesHandler ¶
func NewCreateExpectedMachinesHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateExpectedMachinesHandler
NewCreateExpectedMachinesHandler initializes and returns a new handler for creating multiple ExpectedMachines
func (CreateExpectedMachinesHandler) Handle ¶
func (cemh CreateExpectedMachinesHandler) Handle(c echo.Context) error
Handle godoc @Summary Create multiple ExpectedMachines @Description Create multiple ExpectedMachines in a single request. All machines must belong to the same site. @Tags ExpectedMachine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body []model.APIExpectedMachineCreateRequest true "ExpectedMachine batch creation request" @Success 201 {object} model.APIExpectedMachineBatchResponse @Router /v2/org/{org}/nico/expected-machine/batch [post]
type CreateExpectedPowerShelfHandler ¶
type CreateExpectedPowerShelfHandler struct {
// contains filtered or unexported fields
}
CreateExpectedPowerShelfHandler is the API Handler for creating new ExpectedPowerShelf
func NewCreateExpectedPowerShelfHandler ¶
func NewCreateExpectedPowerShelfHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateExpectedPowerShelfHandler
NewCreateExpectedPowerShelfHandler initializes and returns a new handler for creating ExpectedPowerShelf
func (CreateExpectedPowerShelfHandler) Handle ¶
func (cepsh CreateExpectedPowerShelfHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an ExpectedPowerShelf @Description Create an ExpectedPowerShelf @Tags ExpectedPowerShelf @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIExpectedPowerShelfCreateRequest true "ExpectedPowerShelf creation request" @Success 201 {object} model.APIExpectedPowerShelf @Router /v2/org/{org}/nico/expected-power-shelf [post]
type CreateExpectedRackGroupHandler ¶
type CreateExpectedRackGroupHandler struct {
// contains filtered or unexported fields
}
CreateExpectedRackGroupHandler is the API Handler for creating a new ExpectedRackGroup
func NewCreateExpectedRackGroupHandler ¶
func NewCreateExpectedRackGroupHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateExpectedRackGroupHandler
NewCreateExpectedRackGroupHandler initializes and returns a new handler for creating ExpectedRackGroup
func (CreateExpectedRackGroupHandler) Handle ¶
func (cerh CreateExpectedRackGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an ExpectedRackGroup @Description Create an ExpectedRackGroup @Tags ExpectedRackGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIExpectedRackGroupCreateRequest true "ExpectedRackGroup creation request" @Success 201 {object} model.APIExpectedRackGroup @Router /v2/org/{org}/nico/expected-rack-group [post]
type CreateExpectedRackHandler ¶
type CreateExpectedRackHandler struct {
// contains filtered or unexported fields
}
CreateExpectedRackHandler is the API Handler for creating a new ExpectedRack
func NewCreateExpectedRackHandler ¶
func NewCreateExpectedRackHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateExpectedRackHandler
NewCreateExpectedRackHandler initializes and returns a new handler for creating ExpectedRack
func (CreateExpectedRackHandler) Handle ¶
func (cerh CreateExpectedRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an ExpectedRack @Description Create an ExpectedRack @Tags ExpectedRack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIExpectedRackCreateRequest true "ExpectedRack creation request" @Success 201 {object} model.APIExpectedRack @Router /v2/org/{org}/expected-rack [post]
type CreateExpectedSwitchHandler ¶
type CreateExpectedSwitchHandler struct {
// contains filtered or unexported fields
}
CreateExpectedSwitchHandler is the API Handler for creating new ExpectedSwitch
func NewCreateExpectedSwitchHandler ¶
func NewCreateExpectedSwitchHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateExpectedSwitchHandler
NewCreateExpectedSwitchHandler initializes and returns a new handler for creating ExpectedSwitch
func (CreateExpectedSwitchHandler) Handle ¶
func (cesh CreateExpectedSwitchHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an ExpectedSwitch @Description Create an ExpectedSwitch @Tags ExpectedSwitch @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIExpectedSwitchCreateRequest true "ExpectedSwitch creation request" @Success 201 {object} model.APIExpectedSwitch @Router /v2/org/{org}/nico/expected-switch [post]
type CreateIPBlockHandler ¶
type CreateIPBlockHandler struct {
// contains filtered or unexported fields
}
CreateIPBlockHandler is the API Handler for creating new IPBlock
func NewCreateIPBlockHandler ¶
func NewCreateIPBlockHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) CreateIPBlockHandler
NewCreateIPBlockHandler initializes and returns a new handler for creating IPBlock
func (CreateIPBlockHandler) Handle ¶
func (cipbh CreateIPBlockHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a IPBlock @Description Create a IPBlock @Tags IPBlock @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIIPBlockCreateRequest true "IPBlock creation request" @Success 201 {object} model.APIIPBlock @Router /v2/org/{org}/nico/ipblock [post]
type CreateInfiniBandPartitionHandler ¶
type CreateInfiniBandPartitionHandler struct {
// contains filtered or unexported fields
}
CreateInfiniBandPartitionHandler is the API Handler for creating new InfiniBandPartition
func NewCreateInfiniBandPartitionHandler ¶
func NewCreateInfiniBandPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateInfiniBandPartitionHandler
NewCreateInfiniBandPartitionHandler initializes and returns a new handler for creating InfiniBandPartition
func (CreateInfiniBandPartitionHandler) Handle ¶
func (cibph CreateInfiniBandPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an InfiniBandPartition @Description Create an InfiniBandPartition @Tags InfiniBandPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIInfiniBandPartitionCreateRequest true "InfiniBandPartition creation request" @Success 201 {object} model.APIInfiniBandPartition @Router /v2/org/{org}/nico/infiniband-partition [post]
type CreateInfrastructureProviderHandler ¶
type CreateInfrastructureProviderHandler struct {
// contains filtered or unexported fields
}
CreateInfrastructureProviderHandler is the API Handler for creating new Infrastructure Provider
func NewCreateInfrastructureProviderHandler ¶
func NewCreateInfrastructureProviderHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) CreateInfrastructureProviderHandler
NewCreateInfrastructureProviderHandler initializes and returns a new handler for creating Infrastructure Provider
func (CreateInfrastructureProviderHandler) Handle ¶
func (ciph CreateInfrastructureProviderHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an Infrastructure Provider for the org @Description Create an Infrastructure Provider for the org. Only one Infrastructure Provider is allowed per org. @Tags infrastructureprovider @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIInfrastructureProviderCreateRequest true "Infrastructure Provider create request" @Success 201 {object} model.APIInfrastructureProvider @Router /v2/org/{org}/nico/infrastructure-provider [post]
type CreateInstanceHandler ¶
type CreateInstanceHandler struct {
// contains filtered or unexported fields
}
CreateInstanceHandler is the API Handler for creating new Instance
func NewCreateInstanceHandler ¶
func NewCreateInstanceHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config, dps dpsclient.PowerProvisioner) CreateInstanceHandler
NewCreateInstanceHandler initializes and returns a new handler for creating Instance
func (CreateInstanceHandler) Handle ¶
func (cih CreateInstanceHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an Instance @Description Create an Instance for the org. @Tags Instance @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIInstanceCreateRequest true "Instance create request" @Success 201 {object} model.APIInstance @Router /v2/org/{org}/nico/instance [post]
type CreateInstanceTypeHandler ¶
type CreateInstanceTypeHandler struct {
// contains filtered or unexported fields
}
CreateInstanceTypeHandler is the API Handler for creating new InstanceType
func NewCreateInstanceTypeHandler ¶
func NewCreateInstanceTypeHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateInstanceTypeHandler
NewCreateInstanceTypeHandler initializes and returns a new handler for creating Instance Type
func (CreateInstanceTypeHandler) Handle ¶
func (cith CreateInstanceTypeHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an Instance Type for a Site @Description Create an Instance Type for a Site. Only Infrastructure Providers can create an Instance Type @Tags instancetype @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIInstanceTypeCreateRequest true "Instance Type create request" @Success 201 {object} model.APIInstanceType @Router /v2/org/{org}/nico/instance/type [post]
type CreateMachineInstanceTypeHandler ¶
type CreateMachineInstanceTypeHandler struct {
// contains filtered or unexported fields
}
CreateMachineInstanceTypeHandler is the API Handler for creating new Machine/InstanceType association
func NewCreateMachineInstanceTypeHandler ¶
func NewCreateMachineInstanceTypeHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateMachineInstanceTypeHandler
NewCreateMachineInstanceTypeHandler initializes and returns a new handler for creating Machine/Instance Type association
func (CreateMachineInstanceTypeHandler) Handle ¶
func (cmith CreateMachineInstanceTypeHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an association between Machine and Instance Type @Description Create an association between Machine and Instance Type. Only Infrastructure Providers who own both the Machine and the Instance Type can create the association. @Tags machineinstancetype @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param instance_type_id query string true "ID of Instance Type" @Param message body model.APIMachineInstanceTypeCreateRequest true "Instance Type create request" @Success 201 {object} model.APIMachineInstanceType @Router /v2/org/{org}/nico/instance/type/{instance_type_id}/machine [post]
type CreateMachineValidationExternalConfigHandler ¶
type CreateMachineValidationExternalConfigHandler struct {
// contains filtered or unexported fields
}
CreateMachineValidationExternalConfigHandler is the API Handler for creating new MachineValidationExternalConfig
func NewCreateMachineValidationExternalConfigHandler ¶
func NewCreateMachineValidationExternalConfigHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) CreateMachineValidationExternalConfigHandler
NewCreateMachineValidationExternalConfigHandler initializes and returns a new handler for creating MachineValidationExternalConfig
func (CreateMachineValidationExternalConfigHandler) Handle ¶
func (handler CreateMachineValidationExternalConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a MachineValidationExternalConfig @Description Create a MachineValidationExternalConfig @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIMachineValidationExternalConfigCreateRequest true "MachineValidationExternalConfig creation request" @Success 201 {object} model.APIMachineValidationExternalConfig @Router /v2/org/{org}/nico/site/{site}/machine-validation/external-config [post]
type CreateMachineValidationRunHandler ¶
type CreateMachineValidationRunHandler struct {
// contains filtered or unexported fields
}
CreateMachineValidationRunHandler creates an on-demand validation run for a Machine.
func NewCreateMachineValidationRunHandler ¶
func NewCreateMachineValidationRunHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) CreateMachineValidationRunHandler
NewCreateMachineValidationRunHandler returns a new CreateMachineValidationRunHandler.
func (CreateMachineValidationRunHandler) Handle ¶
func (h CreateMachineValidationRunHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an on-demand Machine validation run @Description Create an on-demand validation run for a Machine. @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param machineId path string true "ID of Machine" @Param request body model.APIMachineValidationRunCreateRequest false "On-demand Machine validation options" @Success 202 {object} model.APIMachineValidationRun @Router /v2/org/{org}/nico/machine/{machineId}/validation/run [post]
type CreateMachineValidationTestHandler ¶
type CreateMachineValidationTestHandler struct {
// contains filtered or unexported fields
}
CreateMachineValidationTestHandler is the API Handler for creating new MachineValidationTest
func NewCreateMachineValidationTestHandler ¶
func NewCreateMachineValidationTestHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) CreateMachineValidationTestHandler
NewCreateMachineValidationTestHandler initializes and returns a new handler for creating MachineValidationTest
func (CreateMachineValidationTestHandler) Handle ¶
func (handler CreateMachineValidationTestHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a MachineValidationTest @Description Create a MachineValidationTest @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIMachineValidationTestCreateRequest true "MachineValidationTest creation request" @Success 201 {object} model.APIMachineValidationTest @Router /v2/org/{org}/nico/site/{site}/machine-validation/test [post]
type CreateMeasuredBootTrustedMachineHandler ¶
type CreateMeasuredBootTrustedMachineHandler struct {
// contains filtered or unexported fields
}
CreateMeasuredBootTrustedMachineHandler creates a machine trust approval.
func NewCreateMeasuredBootTrustedMachineHandler ¶
func NewCreateMeasuredBootTrustedMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool) CreateMeasuredBootTrustedMachineHandler
NewCreateMeasuredBootTrustedMachineHandler returns a machine trust approval creation handler.
type CreateMeasuredBootTrustedProfileHandler ¶
type CreateMeasuredBootTrustedProfileHandler struct {
// contains filtered or unexported fields
}
CreateMeasuredBootTrustedProfileHandler creates a profile trust approval.
func NewCreateMeasuredBootTrustedProfileHandler ¶
func NewCreateMeasuredBootTrustedProfileHandler(dbSession *cdb.Session, scp *sc.ClientPool) CreateMeasuredBootTrustedProfileHandler
NewCreateMeasuredBootTrustedProfileHandler returns a profile trust approval creation handler.
type CreateNVLinkLogicalPartitionHandler ¶
type CreateNVLinkLogicalPartitionHandler struct {
// contains filtered or unexported fields
}
CreateNVLinkLogicalPartitionHandler is the API Handler for creating new NVLinkLogicalPartition
func NewCreateNVLinkLogicalPartitionHandler ¶
func NewCreateNVLinkLogicalPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateNVLinkLogicalPartitionHandler
NewCreateNVLinkLogicalPartitionHandler initializes and returns a new handler for creating NVLinkLogicalPartition
func (CreateNVLinkLogicalPartitionHandler) Handle ¶
func (cibph CreateNVLinkLogicalPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an NVLinkLogicalPartition @Description Create an NVLinkLogicalPartition @Tags NVLinkLogicalPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APINVLinkLogicalPartitionCreateRequest true "NVLinkLogicalPartition creation request" @Success 201 {object} model.APINVLinkLogicalPartition @Router /v2/org/{org}/nico/nvlink-logical-partition [post]
type CreateNetworkSecurityGroupHandler ¶
type CreateNetworkSecurityGroupHandler struct {
// contains filtered or unexported fields
}
CreateNetworkSecurityGroupHandler is the API Handler for creating a new NetworkSecurityGroup
func NewCreateNetworkSecurityGroupHandler ¶
func NewCreateNetworkSecurityGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateNetworkSecurityGroupHandler
NewCreateNetworkSecurityGroupHandler initializes and returns a new handler for creating NetworkSecurityGroup
func (CreateNetworkSecurityGroupHandler) Handle ¶
func (cnsgh CreateNetworkSecurityGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a NetworkSecurityGroup @Description Create a NetworkSecurityGroup @Tags NetworkSecurityGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APINetworkSecurityGroupCreateRequest true "NetworkSecurityGroup creation request" @Success 201 {object} model.APINetworkSecurityGroup @Router /v2/org/{org}/nico/network-security-group [post]
type CreateOperatingSystemHandler ¶
type CreateOperatingSystemHandler struct {
// contains filtered or unexported fields
}
CreateOperatingSystemHandler is the API Handler for creating new OperatingSystem
func NewCreateOperatingSystemHandler ¶
func NewCreateOperatingSystemHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateOperatingSystemHandler
NewCreateOperatingSystemHandler initializes and returns a new handler for creating OperatingSystem
func (CreateOperatingSystemHandler) Handle ¶
func (csh CreateOperatingSystemHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an OperatingSystem @Description Create an OperatingSystem @Tags OperatingSystem @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIOperatingSystemCreateRequest true "OperatingSystem creation request" @Success 201 {object} model.APIOperatingSystem @Router /v2/org/{org}/nico/operating-system [post]
type CreateOrUpdateBMCCredentialHandler ¶
type CreateOrUpdateBMCCredentialHandler struct {
// contains filtered or unexported fields
}
CreateOrUpdateBMCCredentialHandler stores (creates or overwrites) a BMC credential.
func NewCreateOrUpdateBMCCredentialHandler ¶
func NewCreateOrUpdateBMCCredentialHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateOrUpdateBMCCredentialHandler
NewCreateOrUpdateBMCCredentialHandler returns a handler for creating or updating a BMC credential.
func (CreateOrUpdateBMCCredentialHandler) Handle ¶
func (h CreateOrUpdateBMCCredentialHandler) Handle(c echo.Context) error
Handle godoc @Summary Create Or Update BMC Credential @Description Create or update a site-wide or per-BMC root credential. Equivalent to `nico-admin-cli credential add-bmc`. @Tags bmc-credential @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param request body model.APIBMCCredentialRequest true "BMC credential" @Success 200 {object} model.APIBMCCredential @Router /v2/org/{org}/nico/credential/bmc [put]
type CreateOrUpdateHostFirmwareConfigHandler ¶
type CreateOrUpdateHostFirmwareConfigHandler struct {
// contains filtered or unexported fields
}
CreateOrUpdateHostFirmwareConfigHandler handles PUT /firmware-config/host.
func NewCreateOrUpdateHostFirmwareConfigHandler ¶
func NewCreateOrUpdateHostFirmwareConfigHandler(dbSession *cdb.Session, scp *sc.ClientPool) CreateOrUpdateHostFirmwareConfigHandler
NewCreateOrUpdateHostFirmwareConfigHandler returns a new CreateOrUpdateHostFirmwareConfigHandler
func (CreateOrUpdateHostFirmwareConfigHandler) Handle ¶
func (uhfch CreateOrUpdateHostFirmwareConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Create or update a HostFirmwareConfig @Description Create or update a HostFirmwareConfig @Tags HostFirmwareConfig @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIHostFirmwareConfigCreateOrUpdateRequest true "HostFirmwareConfig create/update request" @Success 201 {object} model.APIHostFirmwareConfig "Config created on first call" @Success 200 {object} model.APIHostFirmwareConfig "Config replaced/updated" @Failure 503 {object} util.APIError @Router /v2/org/{org}/nico/firmware-config/host [put]
type CreateOrUpdateMachineHealthReportHandler ¶
type CreateOrUpdateMachineHealthReportHandler struct {
// contains filtered or unexported fields
}
CreateOrUpdateMachineHealthReportHandler creates or updates a health report for a given Machine
func NewCreateOrUpdateMachineHealthReportHandler ¶
func NewCreateOrUpdateMachineHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateOrUpdateMachineHealthReportHandler
NewCreateOrUpdateMachineHealthReportHandler returns a new CreateOrUpdateMachineHealthReportHandler
func (CreateOrUpdateMachineHealthReportHandler) Handle ¶
func (h CreateOrUpdateMachineHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Insert Machine Health Report @Description Add or update a Machine health report override. @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Param request body model.APIMachineHealthReportEntryRequest true "Machine health report" @Success 200 {object} model.APIMachineHealthReportEntry @Router /v2/org/{org}/nico/machine/{machineId}/health-report [put]
type CreateOrUpdateRackHealthReportHandler ¶
type CreateOrUpdateRackHealthReportHandler struct {
// contains filtered or unexported fields
}
CreateOrUpdateRackHealthReportHandler creates or updates a Rack health report.
func NewCreateOrUpdateRackHealthReportHandler ¶
func NewCreateOrUpdateRackHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) CreateOrUpdateRackHealthReportHandler
NewCreateOrUpdateRackHealthReportHandler returns a Rack health report insert handler.
func (CreateOrUpdateRackHealthReportHandler) Handle ¶
func (h CreateOrUpdateRackHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Insert Rack Health Report @Description Add or update a Rack health report override. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Rack" @Param request body model.APIRackHealthReportEntryRequest true "Rack health report" @Success 200 {object} model.APIMachineHealthReportEntry @Router /v2/org/{org}/nico/rack/{id}/health-report [put]
type CreateOrUpdateTenantIdentityConfigHandler ¶
type CreateOrUpdateTenantIdentityConfigHandler struct {
// contains filtered or unexported fields
}
CreateOrUpdateTenantIdentityConfigHandler handles PUT /tenant-identity/config.
func NewCreateOrUpdateTenantIdentityConfigHandler ¶
func NewCreateOrUpdateTenantIdentityConfigHandler(dbSession *cdb.Session, scp *sc.ClientPool) CreateOrUpdateTenantIdentityConfigHandler
NewCreateOrUpdateTenantIdentityConfigHandler returns a new CreateOrUpdateTenantIdentityConfigHandler.
func (CreateOrUpdateTenantIdentityConfigHandler) Handle ¶
func (umich CreateOrUpdateTenantIdentityConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Create Or Update Tenant Identity Config @Description Create or update the per-tenant identity (JWT-SVID) config. First call for a tenant generates the signing keypair. @Tags TenantIdentity @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteID path string true "ID of Site" @Param message body model.APITenantIdentityConfigCreateOrUpdateRequest true "Tenant Identity Config create/update request" @Success 201 {object} model.APITenantIdentityConfig "Config created on first call" @Success 200 {object} model.APITenantIdentityConfig "Config replaced/updated" @Failure 409 {object} util.APIError @Failure 503 {object} util.APIError @Router /v2/org/{org}/nico/site/{siteID}/tenant-identity/config [put]
type CreateOrUpdateTenantIdentityTokenDelegationHandler ¶
type CreateOrUpdateTenantIdentityTokenDelegationHandler struct {
// contains filtered or unexported fields
}
CreateOrUpdateTenantIdentityTokenDelegationHandler handles PUT /tenant-identity/token-delegation.
func NewCreateOrUpdateTenantIdentityTokenDelegationHandler ¶
func NewCreateOrUpdateTenantIdentityTokenDelegationHandler(dbSession *cdb.Session, scp *sc.ClientPool) CreateOrUpdateTenantIdentityTokenDelegationHandler
NewCreateOrUpdateTenantIdentityTokenDelegationHandler returns a new CreateOrUpdateTenantIdentityTokenDelegationHandler.
func (CreateOrUpdateTenantIdentityTokenDelegationHandler) Handle ¶
func (utdh CreateOrUpdateTenantIdentityTokenDelegationHandler) Handle(c echo.Context) error
Handle godoc @Summary Create Or Update Token Delegation @Description Register an RFC 8693 token exchange callback URL for the org. Requires tenant-identity/config to exist first. @Tags TenantIdentity @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteID path string true "ID of Site" @Param message body model.APITenantIdentityTokenDelegationCreateOrUpdateRequest true "Token Delegation create/update request" @Success 201 {object} model.APITenantIdentityTokenDelegation "Token delegation created on first call" @Success 200 {object} model.APITenantIdentityTokenDelegation "Token delegation replaced/updated" @Failure 503 {object} util.APIError @Router /v2/org/{org}/nico/site/{siteID}/tenant-identity/token-delegation [put]
type CreateOrUpdateTrayHealthReportHandler ¶
type CreateOrUpdateTrayHealthReportHandler struct {
// contains filtered or unexported fields
}
CreateOrUpdateTrayHealthReportHandler creates or updates a Tray health report.
func NewCreateOrUpdateTrayHealthReportHandler ¶
func NewCreateOrUpdateTrayHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) CreateOrUpdateTrayHealthReportHandler
NewCreateOrUpdateTrayHealthReportHandler returns a Tray health report insert handler.
func (CreateOrUpdateTrayHealthReportHandler) Handle ¶
func (h CreateOrUpdateTrayHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Insert Tray Health Report @Description Add or update a health report override for a Tray component. @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Tray" @Param request body model.APITrayHealthReportEntryRequest true "Tray health report" @Success 200 {object} model.APIMachineHealthReportEntry @Router /v2/org/{org}/nico/tray/{id}/health-report [put]
type CreateSSHKeyGroupHandler ¶
type CreateSSHKeyGroupHandler struct {
// contains filtered or unexported fields
}
CreateSSHKeyGroupHandler is the API Handler for creating new SSH Key Group
func NewCreateSSHKeyGroupHandler ¶
func NewCreateSSHKeyGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) CreateSSHKeyGroupHandler
NewCreateSSHKeyGroupHandler initializes and returns a new handler for creating SSH Key Group
func (CreateSSHKeyGroupHandler) Handle ¶
func (cskgh CreateSSHKeyGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an SSH Key Group @Description Create an SSH Key Group for the org. @Tags SSHKeyGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APISSHKeyGroupCreateRequest true "SSH Key Group create request" @Success 201 {object} model.APISSHKeyGroup @Router /v2/org/{org}/nico/sshkeygroup [post]
type CreateSSHKeyHandler ¶
type CreateSSHKeyHandler struct {
// contains filtered or unexported fields
}
CreateSSHKeyHandler is the API Handler for creating new SSHKey
func NewCreateSSHKeyHandler ¶
func NewCreateSSHKeyHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) CreateSSHKeyHandler
NewCreateSSHKeyHandler initializes and returns a new handler for creating SSH Key
func (CreateSSHKeyHandler) Handle ¶
func (cskh CreateSSHKeyHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an SSH Key @Description Create an SSH Key for the org. @Tags SSHKey @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APISSHKeyCreateRequest true "SSH Key create request" @Success 201 {object} model.APISSHKey @Router /v2/org/{org}/nico/sshkey [post]
type CreateSiteHandler ¶
type CreateSiteHandler struct {
// contains filtered or unexported fields
}
CreateSiteHandler is the API Handler for creating new Tenant
func NewCreateSiteHandler ¶
func NewCreateSiteHandler(dbSession *cdb.Session, tc tClient.Client, tnc tClient.NamespaceClient, cfg *config.Config) CreateSiteHandler
NewCreateSiteHandler initializes and returns a new handler for creating Tenant
func (CreateSiteHandler) Handle ¶
func (csh CreateSiteHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a Site @Description Create a Site for the org. Only Infrastructure Providers can create Site @Tags site @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APISiteCreateRequest true "Site create request" @Success 201 {object} model.APISite @Router /v2/org/{org}/nico/site [post]
type CreateSkuHandler ¶
type CreateSkuHandler struct {
// contains filtered or unexported fields
}
CreateSkuHandler creates one SKU on a Site's Core service.
func NewCreateSkuHandler ¶
func NewCreateSkuHandler(dbSession *cdb.Session, scp *sc.ClientPool) CreateSkuHandler
NewCreateSkuHandler initializes and returns a new CreateSkuHandler.
func (CreateSkuHandler) Handle ¶
func (csh CreateSkuHandler) Handle(c echo.Context) error
Handle godoc @Summary Create SKU @Description Create a SKU on the selected Site's Core service. @Tags SKU @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param request body model.APISkuCreateRequest true "SKU create request" @Success 201 {object} model.APISku @Router /v2/org/{org}/nico/sku [post]
type CreateSpectrumXPartitionHandler ¶
type CreateSpectrumXPartitionHandler struct {
// contains filtered or unexported fields
}
CreateSpectrumXPartitionHandler is the API Handler for creating a new SpectrumXPartition
func NewCreateSpectrumXPartitionHandler ¶
func NewCreateSpectrumXPartitionHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) CreateSpectrumXPartitionHandler
NewCreateSpectrumXPartitionHandler returns a handler for creating a SpectrumXPartition
func (CreateSpectrumXPartitionHandler) Handle ¶
func (csxph CreateSpectrumXPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a SpectrumXPartition @Description Create a SpectrumXPartition @Tags SpectrumXPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APISpectrumXPartitionCreateRequest true "SpectrumXPartition creation request" @Success 201 {object} model.APISpectrumXPartition @Router /v2/org/{org}/nico/spectrumx-partition [post]
type CreateSubnetHandler ¶
type CreateSubnetHandler struct {
// contains filtered or unexported fields
}
CreateSubnetHandler creates IPv4 Subnets for Ethernet virtualizer VPCs. FNN VPCs use the separate VPC Prefix resource.
func NewCreateSubnetHandler ¶
func NewCreateSubnetHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateSubnetHandler
NewCreateSubnetHandler initializes and returns a new handler for creating Subnet
func (CreateSubnetHandler) Handle ¶
func (csh CreateSubnetHandler) Handle(c echo.Context) error
Handle godoc @Summary Create Subnet @Description Creates an IPv4 Subnet in an Ethernet virtualizer VPC. FNN VPCs use VPC Prefixes. @Tags Subnet @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APISubnetCreateRequest true "Subnet creation request" @Success 201 {object} model.APISubnet @Router /v2/org/{org}/nico/subnet [post]
type CreateTaskRuleHandler ¶
type CreateTaskRuleHandler struct {
// contains filtered or unexported fields
}
CreateTaskRuleHandler is the API Handler for creating a new Operation Rule.
func NewCreateTaskRuleHandler ¶
func NewCreateTaskRuleHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateTaskRuleHandler
NewCreateTaskRuleHandler initializes and returns a new handler for creating a Rule.
func (CreateTaskRuleHandler) Handle ¶
func (h CreateTaskRuleHandler) Handle(c echo.Context) error
Handle godoc @Summary Create an Operation Rule @Description Create a new Operation Rule on the target Site. The rule definition is validated server-side; on validation failure no state changes. @Tags rule @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APITaskRuleCreateRequest true "Create rule request" @Success 201 {object} model.APITaskRule @Router /v2/org/{org}/nico/task/rule [post]
type CreateTaskRunHandler ¶
type CreateTaskRunHandler struct {
// contains filtered or unexported fields
}
CreateTaskRunHandler is the API Handler for creating a Run.
func NewCreateTaskRunHandler ¶
func NewCreateTaskRunHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateTaskRunHandler
NewCreateTaskRunHandler initializes a new CreateTaskRunHandler.
func (CreateTaskRunHandler) Handle ¶
func (h CreateTaskRunHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a Run @Description Create a Run: a phased, policy-gated execution of one operation across many racks. The configuration is validated server-side; on validation failure no state changes. @Tags run @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param body body model.APITaskRunCreateRequest true "Create run request" @Success 201 {object} model.APITaskRun @Router /v2/org/{org}/nico/task/run [post]
type CreateTenantAccountHandler ¶
type CreateTenantAccountHandler struct {
// contains filtered or unexported fields
}
CreateTenantAccountHandler is the API Handler for creating new TenantAccount
func NewCreateTenantAccountHandler ¶
func NewCreateTenantAccountHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) CreateTenantAccountHandler
NewCreateTenantAccountHandler initializes and returns a new handler for creating TenantAccount
func (CreateTenantAccountHandler) Handle ¶
func (ctah CreateTenantAccountHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a TenantAccount @Description Create a TenantAccount @Tags tenantaccount @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APITenantAccountCreateRequest true "TenantAccount creation request" @Success 201 {object} model.APITenantAccount @Router /v2/org/{org}/nico/tenant/account [post]
type CreateTenantHandler ¶
type CreateTenantHandler struct {
// contains filtered or unexported fields
}
CreateTenantHandler is the API Handler for creating new Tenant
func NewCreateTenantHandler ¶
func NewCreateTenantHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) CreateTenantHandler
NewCreateTenantHandler initializes and returns a new handler for creating Tenant
func (CreateTenantHandler) Handle ¶
func (cth CreateTenantHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a Tenant for the org @Description Create a Tenant for the org. Only one Tenant is allowed per org. @Tags tenant @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APITenantCreateRequest true "Tenant creation request" @Success 201 {object} model.APITenant @Router /v2/org/{org}/nico/tenant [post]
type CreateUEFICredentialHandler ¶
type CreateUEFICredentialHandler struct {
// contains filtered or unexported fields
}
CreateUEFICredentialHandler creates a site-default host or DPU UEFI credential.
func NewCreateUEFICredentialHandler ¶
func NewCreateUEFICredentialHandler(dbSession *cdb.Session, scp *sc.ClientPool) CreateUEFICredentialHandler
NewCreateUEFICredentialHandler returns a handler for creating a UEFI credential.
func (CreateUEFICredentialHandler) Handle ¶
func (h CreateUEFICredentialHandler) Handle(c echo.Context) error
Handle godoc @Summary Create UEFI Credential @Description Create a site-default host or DPU UEFI credential. Equivalent to `nico-admin-cli credential add-uefi`. @Tags uefi-credential @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param request body model.APIUEFICredentialRequest true "UEFI credential" @Success 201 {object} model.APIUEFICredential @Router /v2/org/{org}/nico/credential/uefi [post]
type CreateVPCHandler ¶
type CreateVPCHandler struct {
// contains filtered or unexported fields
}
CreateVPCHandler is the API Handler for creating new VPC
func NewCreateVPCHandler ¶
func NewCreateVPCHandler(dbSession *cdb.Session, tc temporalClient.Client, sc *sc.ClientPool, cfg *config.Config, dps dpsclient.PowerProvisioner) CreateVPCHandler
NewCreateVPCHandler initializes and returns a new handler for creating Tenant
func (CreateVPCHandler) Handle ¶
func (cvh CreateVPCHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a VPC @Description Create a VPC for the org. @Tags vpc @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIVpcCreateRequest true "VPC create request" @Success 201 {object} model.APIVpc @Router /v2/org/{org}/nico/vpc [post]
type CreateVpcPeeringHandler ¶
type CreateVpcPeeringHandler struct {
// contains filtered or unexported fields
}
CreateVpcPeeringHandler is the API Handler for creating new VPC Peering
func NewCreateVpcPeeringHandler ¶
func NewCreateVpcPeeringHandler(dbSession *cdb.Session, tc tclient.Client, sc *sc.ClientPool, cfg *config.Config) CreateVpcPeeringHandler
NewCreateVpcPeeringHandler initializes and returns a new handler for creating VPC Peering
func (CreateVpcPeeringHandler) Handle ¶
func (cvph CreateVpcPeeringHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a VPC Peering @Description Create a VPC Peering between two VPCs on the same site. @Tags vpcpeering @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIVpcPeeringCreateRequest true "VPC Peering create request" @Success 201 {object} model.APIVpcPeering @Router /v2/org/{org}/nico/vpc-peering [post]
type CreateVpcPrefixHandler ¶
type CreateVpcPrefixHandler struct {
// contains filtered or unexported fields
}
CreateVpcPrefixHandler is the API Handler for creating new VPC prefix
func NewCreateVpcPrefixHandler ¶
func NewCreateVpcPrefixHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) CreateVpcPrefixHandler
NewCreateVpcPrefixHandler initializes and returns a new handler for creating VPC prefix
func (CreateVpcPrefixHandler) Handle ¶
func (csh CreateVpcPrefixHandler) Handle(c echo.Context) error
Handle godoc @Summary Create a VPC prefix @Description Create a VPC prefix @Tags vpcprefix @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIVpcPrefixCreateRequest true "VPC prefix creation request" @Success 201 {object} model.APIVpcPrefix @Router /v2/org/{org}/nico/vpcprefix [post]
type DecommissionMachineHandler ¶
type DecommissionMachineHandler struct {
// contains filtered or unexported fields
}
DecommissionMachineHandler starts decommissioning a Machine.
func NewDecommissionMachineHandler ¶
func NewDecommissionMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) DecommissionMachineHandler
NewDecommissionMachineHandler returns a new Machine decommissioning handler.
func (DecommissionMachineHandler) Handle ¶
func (h DecommissionMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Decommission a Machine @Description Start the Machine decommissioning workflow. @Tags Machine @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Success 202 {object} model.APIMessageResponse @Router /v2/org/{org}/nico/machine/{machineId}/decommission [post]
type DecommissionTrayHandler ¶
type DecommissionTrayHandler struct {
// contains filtered or unexported fields
}
DecommissionTrayHandler starts decommissioning a managed tray.
func NewDecommissionTrayHandler ¶
func NewDecommissionTrayHandler(dbSession *cdb.Session, scp *sc.ClientPool) DecommissionTrayHandler
NewDecommissionTrayHandler returns a tray decommission handler.
func (DecommissionTrayHandler) Handle ¶
func (h DecommissionTrayHandler) Handle(c echo.Context) error
Handle godoc @Summary Decommission a Tray @Description Start decommissioning a Ready managed tray through Core. @Tags Tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of the Org" @Param id path string true "Core inventory ID of Tray" @Param request body model.APITrayDecommissionRequest true "Site containing the tray" @Success 202 {object} model.APIMessageResponse @Router /v2/org/{org}/nico/tray/{id}/decommission [post]
type DeleteAllExpectedMachinesHandler ¶
type DeleteAllExpectedMachinesHandler struct {
// contains filtered or unexported fields
}
DeleteAllExpectedMachinesHandler deletes the complete ExpectedMachine set for one Site.
func NewDeleteAllExpectedMachinesHandler ¶
func NewDeleteAllExpectedMachinesHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteAllExpectedMachinesHandler
NewDeleteAllExpectedMachinesHandler creates a full-Site ExpectedMachine deletion handler.
func (DeleteAllExpectedMachinesHandler) Handle ¶
func (h DeleteAllExpectedMachinesHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete all ExpectedMachines for a Site @Tags ExpectedMachine @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site whose ExpectedMachines should be deleted" @Success 204 @Router /v2/org/{org}/nico/expected-machine/all [delete]
type DeleteAllExpectedPowerShelvesHandler ¶
type DeleteAllExpectedPowerShelvesHandler struct {
// contains filtered or unexported fields
}
DeleteAllExpectedPowerShelvesHandler deletes the complete ExpectedPowerShelf set for one Site.
func NewDeleteAllExpectedPowerShelvesHandler ¶
func NewDeleteAllExpectedPowerShelvesHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteAllExpectedPowerShelvesHandler
NewDeleteAllExpectedPowerShelvesHandler creates a full-Site ExpectedPowerShelf deletion handler.
func (DeleteAllExpectedPowerShelvesHandler) Handle ¶
func (h DeleteAllExpectedPowerShelvesHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete all ExpectedPowerShelves for a Site @Tags ExpectedPowerShelf @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site whose ExpectedPowerShelves should be deleted" @Success 204 @Router /v2/org/{org}/nico/expected-power-shelf/all [delete]
type DeleteAllExpectedRackGroupsHandler ¶
type DeleteAllExpectedRackGroupsHandler struct {
// contains filtered or unexported fields
}
DeleteAllExpectedRackGroupsHandler is the API Handler for deleting all ExpectedRackGroups scoped to a specific Site (siteId query parameter).
func NewDeleteAllExpectedRackGroupsHandler ¶
func NewDeleteAllExpectedRackGroupsHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteAllExpectedRackGroupsHandler
NewDeleteAllExpectedRackGroupsHandler initializes and returns a new handler for deleting all ExpectedRackGroups for a Site
func (DeleteAllExpectedRackGroupsHandler) Handle ¶
func (daerh DeleteAllExpectedRackGroupsHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete all ExpectedRackGroups for a Site @Description Delete all ExpectedRackGroups for the Site identified by siteId query parameter @Tags ExpectedRackGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site whose ExpectedRackGroups should be deleted" @Success 204 @Router /v2/org/{org}/nico/expected-rack-group/all [delete]
type DeleteAllExpectedRacksHandler ¶
type DeleteAllExpectedRacksHandler struct {
// contains filtered or unexported fields
}
DeleteAllExpectedRacksHandler is the API Handler for deleting all ExpectedRacks scoped to a specific Site (siteId query parameter).
func NewDeleteAllExpectedRacksHandler ¶
func NewDeleteAllExpectedRacksHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteAllExpectedRacksHandler
NewDeleteAllExpectedRacksHandler initializes and returns a new handler for deleting all ExpectedRacks for a Site
func (DeleteAllExpectedRacksHandler) Handle ¶
func (daerh DeleteAllExpectedRacksHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete all ExpectedRacks for a Site @Description Delete all ExpectedRacks for the Site identified by siteId query parameter @Tags ExpectedRack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site whose ExpectedRacks should be deleted" @Success 204 @Router /v2/org/{org}/nico/expected-rack/all [delete]
type DeleteAllExpectedSwitchesHandler ¶
type DeleteAllExpectedSwitchesHandler struct {
// contains filtered or unexported fields
}
DeleteAllExpectedSwitchesHandler deletes the complete ExpectedSwitch set for one Site.
func NewDeleteAllExpectedSwitchesHandler ¶
func NewDeleteAllExpectedSwitchesHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteAllExpectedSwitchesHandler
NewDeleteAllExpectedSwitchesHandler creates a full-Site ExpectedSwitch deletion handler.
func (DeleteAllExpectedSwitchesHandler) Handle ¶
func (h DeleteAllExpectedSwitchesHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete all ExpectedSwitches for a Site @Tags ExpectedSwitch @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site whose ExpectedSwitches should be deleted" @Success 204 @Router /v2/org/{org}/nico/expected-switch/all [delete]
type DeleteAllocationHandler ¶
type DeleteAllocationHandler struct {
// contains filtered or unexported fields
}
DeleteAllocationHandler is the API Handler for deleting a Allocation
func NewDeleteAllocationHandler ¶
func NewDeleteAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) DeleteAllocationHandler
NewDeleteAllocationHandler initializes and returns a new handler for deleting Allocation
func (DeleteAllocationHandler) Handle ¶
func (dah DeleteAllocationHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing Allocation @Description Delete an existing Allocation @Tags Allocation @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Allocation" @Success 202 @Router /v2/org/{org}/nico/allocation/{id} [delete]
type DeleteDpuExtensionServiceHandler ¶
type DeleteDpuExtensionServiceHandler struct {
// contains filtered or unexported fields
}
DeleteDpuExtensionServiceHandler is the API Handler for deleting a DPU Extension Service
func NewDeleteDpuExtensionServiceHandler ¶
func NewDeleteDpuExtensionServiceHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteDpuExtensionServiceHandler
NewDeleteDpuExtensionServiceHandler initializes and returns a new handler for deleting DPU Extension Service
func (DeleteDpuExtensionServiceHandler) Handle ¶
func (ddesh DeleteDpuExtensionServiceHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a DPU Extension Service @Description Delete a DPU Extension Service by ID. All versions will be deleted. @Tags DPU Extension Service @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param dpuExtensionServiceId path string true "ID of DPU Extension Service" @Success 202 {object} model.APIMessageResponse "DPF Helm chart deletion accepted" @Success 204 "Kubernetes Pod service deleted" @Router /v2/org/{org}/nico/dpu-extension-service/{dpuExtensionServiceId} [delete]
type DeleteDpuExtensionServiceVersionHandler ¶
type DeleteDpuExtensionServiceVersionHandler struct {
// contains filtered or unexported fields
}
DeleteDpuExtensionServiceVersionHandler is the API Handler for deleting a DPU Extension Service version
func NewDeleteDpuExtensionServiceVersionHandler ¶
func NewDeleteDpuExtensionServiceVersionHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteDpuExtensionServiceVersionHandler
NewDeleteDpuExtensionServiceVersionHandler initializes and returns a new handler for deleting DPU Extension Service version
func (DeleteDpuExtensionServiceVersionHandler) Handle ¶
func (ddesvh DeleteDpuExtensionServiceVersionHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a DPU Extension Service version @Description Delete a specific version of a DPU Extension Service. The version being deleted cannot have active deployments. @Tags DPU Extension Service @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param dpuExtensionServiceId path string true "ID of DPU Extension Service" @Param versionId path string true "Version ID" @Success 202 "Accepted" @Router /v2/org/{org}/nico/dpu-extension-service/{dpuExtensionServiceId}/version/{versionId} [delete]
type DeleteExpectedMachineHandler ¶
type DeleteExpectedMachineHandler struct {
// contains filtered or unexported fields
}
DeleteExpectedMachineHandler is the API Handler for deleting a ExpectedMachine
func NewDeleteExpectedMachineHandler ¶
func NewDeleteExpectedMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteExpectedMachineHandler
NewDeleteExpectedMachineHandler initializes and returns a new handler for deleting ExpectedMachine
func (DeleteExpectedMachineHandler) Handle ¶
func (demh DeleteExpectedMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing ExpectedMachine @Description Delete an existing ExpectedMachine by ID @Tags ExpectedMachine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Machine" @Success 204 @Router /v2/org/{org}/nico/expected-machine/{id} [delete]
type DeleteExpectedPowerShelfHandler ¶
type DeleteExpectedPowerShelfHandler struct {
// contains filtered or unexported fields
}
DeleteExpectedPowerShelfHandler is the API Handler for deleting a ExpectedPowerShelf
func NewDeleteExpectedPowerShelfHandler ¶
func NewDeleteExpectedPowerShelfHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteExpectedPowerShelfHandler
NewDeleteExpectedPowerShelfHandler initializes and returns a new handler for deleting ExpectedPowerShelf
func (DeleteExpectedPowerShelfHandler) Handle ¶
func (depsh DeleteExpectedPowerShelfHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing ExpectedPowerShelf @Description Delete an existing ExpectedPowerShelf by ID @Tags ExpectedPowerShelf @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Power Shelf" @Success 204 @Router /v2/org/{org}/nico/expected-power-shelf/{id} [delete]
type DeleteExpectedRackGroupHandler ¶
type DeleteExpectedRackGroupHandler struct {
// contains filtered or unexported fields
}
DeleteExpectedRackGroupHandler is the API Handler for deleting an ExpectedRackGroup
func NewDeleteExpectedRackGroupHandler ¶
func NewDeleteExpectedRackGroupHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteExpectedRackGroupHandler
NewDeleteExpectedRackGroupHandler initializes and returns a new handler for deleting ExpectedRackGroup
func (DeleteExpectedRackGroupHandler) Handle ¶
func (derh DeleteExpectedRackGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing ExpectedRackGroup @Description Delete an existing ExpectedRackGroup by ID @Tags ExpectedRackGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Rack Group" @Success 204 @Router /v2/org/{org}/nico/expected-rack-group/{id} [delete]
type DeleteExpectedRackHandler ¶
type DeleteExpectedRackHandler struct {
// contains filtered or unexported fields
}
DeleteExpectedRackHandler is the API Handler for deleting an ExpectedRack
func NewDeleteExpectedRackHandler ¶
func NewDeleteExpectedRackHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteExpectedRackHandler
NewDeleteExpectedRackHandler initializes and returns a new handler for deleting ExpectedRack
func (DeleteExpectedRackHandler) Handle ¶
func (derh DeleteExpectedRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing ExpectedRack @Description Delete an existing ExpectedRack by ID @Tags ExpectedRack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Rack" @Success 204 @Router /v2/org/{org}/expected-rack/{id} [delete]
type DeleteExpectedSwitchHandler ¶
type DeleteExpectedSwitchHandler struct {
// contains filtered or unexported fields
}
DeleteExpectedSwitchHandler is the API Handler for deleting a ExpectedSwitch
func NewDeleteExpectedSwitchHandler ¶
func NewDeleteExpectedSwitchHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteExpectedSwitchHandler
NewDeleteExpectedSwitchHandler initializes and returns a new handler for deleting ExpectedSwitch
func (DeleteExpectedSwitchHandler) Handle ¶
func (desh DeleteExpectedSwitchHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing ExpectedSwitch @Description Delete an existing ExpectedSwitch by ID @Tags ExpectedSwitch @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Switch" @Success 204 @Router /v2/org/{org}/nico/expected-switch/{id} [delete]
type DeleteHostFirmwareConfigHandler ¶
type DeleteHostFirmwareConfigHandler struct {
// contains filtered or unexported fields
}
DeleteHostFirmwareConfigHandler handles DELETE /firmware-config/host.
func NewDeleteHostFirmwareConfigHandler ¶
func NewDeleteHostFirmwareConfigHandler(dbSession *cdb.Session, scp *sc.ClientPool) DeleteHostFirmwareConfigHandler
NewDeleteHostFirmwareConfigHandler returns a new DeleteHostFirmwareConfigHandler.
func (DeleteHostFirmwareConfigHandler) Handle ¶
func (dhfch DeleteHostFirmwareConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a HostFirmwareConfig @Description Delete a HostFirmwareConfig keyed by vendor and model and site. @Tags HostFirmwareConfig @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIHostFirmwareConfigDeleteRequest true "HostFirmwareConfig delete request" @Success 204 @Failure 503 {object} util.APIError @Router /v2/org/{org}/nico/firmware-config/host [delete]
type DeleteIPBlockHandler ¶
type DeleteIPBlockHandler struct {
// contains filtered or unexported fields
}
DeleteIPBlockHandler is the API Handler for deleting a IPBlock
func NewDeleteIPBlockHandler ¶
func NewDeleteIPBlockHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) DeleteIPBlockHandler
NewDeleteIPBlockHandler initializes and returns a new handler for deleting IPBlock
func (DeleteIPBlockHandler) Handle ¶
func (dipbh DeleteIPBlockHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing IPBlock @Description Delete an existing IPBlock @Tags IPBlock @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of IPBlock" @Success 202 @Router /v2/org/{org}/nico/ipblock/{id} [delete]
type DeleteInfiniBandPartitionHandler ¶
type DeleteInfiniBandPartitionHandler struct {
// contains filtered or unexported fields
}
DeleteInfiniBandPartitionHandler is the API Handler for deleting a InfiniBandPartition
func NewDeleteInfiniBandPartitionHandler ¶
func NewDeleteInfiniBandPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteInfiniBandPartitionHandler
NewDeleteInfiniBandPartitionHandler initializes and returns a new handler for deleting InfiniBandPartition
func (DeleteInfiniBandPartitionHandler) Handle ¶
func (dibph DeleteInfiniBandPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing InfiniBandPartition @Description Delete an existing InfiniBandPartition @Tags InfiniBandPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of InfiniBandPartition" @Success 202 @Router /v2/org/{org}/nico/infiniband-partition/{id} [delete]
type DeleteInstanceHandler ¶
type DeleteInstanceHandler struct {
// contains filtered or unexported fields
}
DeleteInstanceHandler is the API Handler for deleting an Instance
func NewDeleteInstanceHandler ¶
func NewDeleteInstanceHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config, dps dpsclient.PowerProvisioner) DeleteInstanceHandler
NewDeleteInstanceHandler initializes and r`eturns a new handler for deleting an Instance
func (DeleteInstanceHandler) Handle ¶
func (dih DeleteInstanceHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an Instance @Description Delete an Instance fro the org @Tags Instance @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Instance" @Success 202 @Router /v2/org/{org}/nico/instance/{id} [delete]
type DeleteInstanceTypeHandler ¶
type DeleteInstanceTypeHandler struct {
// contains filtered or unexported fields
}
DeleteInstanceTypeHandler is the API Handler for deleting a Site
func NewDeleteInstanceTypeHandler ¶
func NewDeleteInstanceTypeHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteInstanceTypeHandler
NewDeleteInstanceTypeHandler initializes and returns a new handler for deleting an Instance Type
func (DeleteInstanceTypeHandler) Handle ¶
func (dith DeleteInstanceTypeHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an Instance Type @Description Delete an Instance Type. Org's Infrastructure Provider must be associated with the Instance Type. @Tags instancetype @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Instance Type" @Success 204 @Router /v2/org/{org}/nico/instance/type/{id} [delete]
type DeleteMachineHandler ¶
type DeleteMachineHandler struct {
// contains filtered or unexported fields
}
DeleteMachineHandler is the API Handler for deleting a Machine.
func NewDeleteMachineHandler ¶
func NewDeleteMachineHandler(dbSession *cdb.Session, scp common.SiteTemporalClientPool) DeleteMachineHandler
NewDeleteMachineHandler initializes and returns a new handler to delete a Machine.
func (DeleteMachineHandler) Handle ¶
func (dmh DeleteMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing Machine from Cloud @Description Delete an existing Machine for the org @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Success 202 {object} @Router /v2/org/{org}/nico/machine/{id} [delete]
type DeleteMachineHealthReportHandler ¶
type DeleteMachineHealthReportHandler struct {
// contains filtered or unexported fields
}
DeleteMachineHealthReportHandler deletes a health report for a given Machine
func NewDeleteMachineHealthReportHandler ¶
func NewDeleteMachineHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteMachineHealthReportHandler
NewDeleteMachineHealthReportHandler returns a new DeleteMachineHealthReportHandler
func (DeleteMachineHealthReportHandler) Handle ¶
func (h DeleteMachineHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Remove Machine Health Report @Description Remove a Machine health report override. @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Param source path string true "Health report source" @Success 204 @Router /v2/org/{org}/nico/machine/{machineId}/health-report/{source} [delete]
type DeleteMachineInstanceTypeHandler ¶
type DeleteMachineInstanceTypeHandler struct {
// contains filtered or unexported fields
}
DeleteMachineInstanceTypeHandler is the API Handler for deleting a Machine/InstanceType association
func NewDeleteMachineInstanceTypeHandler ¶
func NewDeleteMachineInstanceTypeHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteMachineInstanceTypeHandler
NewDeleteMachineInstanceTypeHandler initializes and returns a new handler for deleting a Machine/InstanceType association
func (DeleteMachineInstanceTypeHandler) Handle ¶
func (dmith DeleteMachineInstanceTypeHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a Machine/InstanceType association @Description Delete a Machine/InstanceType association for Instance Type. The `{id}` path parameter accepts either a `machineId` or the deprecated Machine/InstanceType association ID, which will be removed on July 9th, 2026 0:00 UTC. @Tags machineinstancetype @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param instance_type_id path string true "ID of Instance Type" @Param id path string true "Machine ID or deprecated ID of Machine/Instance Type association" @Success 204 @Router /v2/org/{org}/nico/instance/type/{instance_type_id}/machine/{id} [delete]
type DeleteMachineValidationExternalConfigHandler ¶
type DeleteMachineValidationExternalConfigHandler struct {
// contains filtered or unexported fields
}
DeleteMachineValidationExternalConfigHandler is the API Handler for delete existing MachineValidationExternalConfig
func NewDeleteMachineValidationExternalConfigHandler ¶
func NewDeleteMachineValidationExternalConfigHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteMachineValidationExternalConfigHandler
NewDeleteMachineValidationExternalConfigHandler initializes and returns a new handler for updating MachineValidationExternalConfig
func (DeleteMachineValidationExternalConfigHandler) Handle ¶
func (handler DeleteMachineValidationExternalConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a MachineValidationExternalConfig @Description Delete a MachineValidationExternalConfig @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 202 @Router /v2/org/{org}/nico/site/{site}/machine-validation/external-config/{name} [delete]
type DeleteMeasuredBootTrustedMachineHandler ¶
type DeleteMeasuredBootTrustedMachineHandler struct {
// contains filtered or unexported fields
}
DeleteMeasuredBootTrustedMachineHandler deletes a machine trust approval.
func NewDeleteMeasuredBootTrustedMachineHandler ¶
func NewDeleteMeasuredBootTrustedMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool) DeleteMeasuredBootTrustedMachineHandler
NewDeleteMeasuredBootTrustedMachineHandler returns a machine trust approval deletion handler.
type DeleteMeasuredBootTrustedProfileHandler ¶
type DeleteMeasuredBootTrustedProfileHandler struct {
// contains filtered or unexported fields
}
DeleteMeasuredBootTrustedProfileHandler deletes a profile trust approval.
func NewDeleteMeasuredBootTrustedProfileHandler ¶
func NewDeleteMeasuredBootTrustedProfileHandler(dbSession *cdb.Session, scp *sc.ClientPool) DeleteMeasuredBootTrustedProfileHandler
NewDeleteMeasuredBootTrustedProfileHandler returns a profile trust approval deletion handler.
type DeleteNVLinkLogicalPartitionHandler ¶
type DeleteNVLinkLogicalPartitionHandler struct {
// contains filtered or unexported fields
}
DeleteNVLinkLogicalPartitionHandler is the API Handler for deleting a NVLinkLogicalPartition
func NewDeleteNVLinkLogicalPartitionHandler ¶
func NewDeleteNVLinkLogicalPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteNVLinkLogicalPartitionHandler
NewDeleteNVLinkLogicalPartitionHandler initializes and returns a new handler for deleting NVLinkLogicalPartition
func (DeleteNVLinkLogicalPartitionHandler) Handle ¶
func (dibph DeleteNVLinkLogicalPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing NVLinkLogicalPartition @Description Delete an existing NVLinkLogicalPartition @Tags NVLinkLogicalPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of NVLinkLogicalPartition" @Success 202 @Router /v2/org/{org}/nico/nvlink-logical-partition/{id} [delete]
type DeleteNetworkSecurityGroupHandler ¶
type DeleteNetworkSecurityGroupHandler struct {
// contains filtered or unexported fields
}
DeleteNetworkSecurityGroupHandler is the API Handler for deleting a new NetworkSecurityGroup
func NewDeleteNetworkSecurityGroupHandler ¶
func NewDeleteNetworkSecurityGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteNetworkSecurityGroupHandler
NewDeleteNetworkSecurityGroupHandler initializes and returns a new handler for creating NetworkSecurityGroup
func (DeleteNetworkSecurityGroupHandler) Handle ¶
func (dnsgh DeleteNetworkSecurityGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a NetworkSecurityGroup @Description Delete a NetworkSecurityGroup @Tags NetworkSecurityGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of NetworkSecurityGroup" @Success 202 {object} model.APINetworkSecurityGroup @Router /v2/org/{org}/nico/network-security-group [post]
type DeleteOperatingSystemHandler ¶
type DeleteOperatingSystemHandler struct {
// contains filtered or unexported fields
}
DeleteOperatingSystemHandler is the API Handler for deleting a OperatingSystem
func NewDeleteOperatingSystemHandler ¶
func NewDeleteOperatingSystemHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteOperatingSystemHandler
NewDeleteOperatingSystemHandler initializes and returns a new handler for deleting OperatingSystem
func (DeleteOperatingSystemHandler) Handle ¶
func (dsh DeleteOperatingSystemHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing OperatingSystem @Description Delete an existing OperatingSystem @Tags OperatingSystem @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of OperatingSystem" @Success 202 @Router /v2/org/{org}/nico/operating-system/{id} [delete]
type DeleteRackHealthReportHandler ¶
type DeleteRackHealthReportHandler struct {
// contains filtered or unexported fields
}
DeleteRackHealthReportHandler deletes a Rack health report.
func NewDeleteRackHealthReportHandler ¶
func NewDeleteRackHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) DeleteRackHealthReportHandler
NewDeleteRackHealthReportHandler returns a Rack health report remove handler.
func (DeleteRackHealthReportHandler) Handle ¶
func (h DeleteRackHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete Rack Health Report @Description Delete a Rack health report override by source. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Rack" @Param source path string true "Health report source" @Param siteId query string true "ID of Site" Format(uuid) @Success 204 @Router /v2/org/{org}/nico/rack/{id}/health-report/{source} [delete]
type DeleteSSHKeyGroupHandler ¶
type DeleteSSHKeyGroupHandler struct {
// contains filtered or unexported fields
}
DeleteSSHKeyGroupHandler is the API Handler for deleting an SSH Key Group
func NewDeleteSSHKeyGroupHandler ¶
func NewDeleteSSHKeyGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) DeleteSSHKeyGroupHandler
NewDeleteSSHKeyGroupHandler initializes and returns a new handler for deleting an SSH Key Group
func (DeleteSSHKeyGroupHandler) Handle ¶
func (dskgh DeleteSSHKeyGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an SSHKeyGroup @Description Delete an SSHKeyGroup from the org @Tags SSHKeyGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of SSHKeyGroup" @Success 202 @Router /v2/org/{org}/nico/sshkeygroup/{id} [delete]
type DeleteSSHKeyHandler ¶
type DeleteSSHKeyHandler struct {
// contains filtered or unexported fields
}
DeleteSSHKeyHandler is the API Handler for deleting an SSH Key
func NewDeleteSSHKeyHandler ¶
func NewDeleteSSHKeyHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) DeleteSSHKeyHandler
NewDeleteSSHKeyHandler initializes and returns a new handler for deleting a SSH Key
func (DeleteSSHKeyHandler) Handle ¶
func (dskh DeleteSSHKeyHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an SSH Key @Description Delete an SSH Key from the org @Tags SSHKey @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of SSHKey" @Success 202 @Router /v2/org/{org}/nico/sshkey/{id} [delete]
type DeleteSiteHandler ¶
type DeleteSiteHandler struct {
// contains filtered or unexported fields
}
DeleteSiteHandler is the API Handler for deleting a Site
func NewDeleteSiteHandler ¶
func NewDeleteSiteHandler(dbSession *cdb.Session, tc tClient.Client, cfg *config.Config) DeleteSiteHandler
NewDeleteSiteHandler initializes and returns a new handler for deleting Site
func (DeleteSiteHandler) Handle ¶
func (dsh DeleteSiteHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a Site @Description Delete a Site owned by the infrastructure provider @Tags site @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Site" @Param purgeMachines query boolean false "Permanently remove all Machines associated with this Site" @Success 204 @Router /v2/org/{org}/nico/site/{id} [delete]
type DeleteSkuHandler ¶
type DeleteSkuHandler struct {
// contains filtered or unexported fields
}
DeleteSkuHandler deletes one unused SKU from a Site's Core service.
func NewDeleteSkuHandler ¶
func NewDeleteSkuHandler(dbSession *cdb.Session, scp *sc.ClientPool) DeleteSkuHandler
NewDeleteSkuHandler returns a new DeleteSkuHandler.
func (DeleteSkuHandler) Handle ¶
func (dsh DeleteSkuHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete SKU @Description Delete an unused SKU. @Tags SKU @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "SKU ID" @Success 204 @Router /v2/org/{org}/nico/sku/{id} [delete]
type DeleteSpectrumXPartitionHandler ¶
type DeleteSpectrumXPartitionHandler struct {
// contains filtered or unexported fields
}
DeleteSpectrumXPartitionHandler is the API Handler for deleting a SpectrumXPartition
func NewDeleteSpectrumXPartitionHandler ¶
func NewDeleteSpectrumXPartitionHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) DeleteSpectrumXPartitionHandler
NewDeleteSpectrumXPartitionHandler returns a handler for deleting a SpectrumXPartition
func (DeleteSpectrumXPartitionHandler) Handle ¶
func (dsxph DeleteSpectrumXPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a SpectrumXPartition @Description Delete a SpectrumXPartition. Returns 400 while the API lists an attached Instance and 412 when the Site reports remaining attachments, including on terminating Instances. @Description A rejected deletion leaves the Partition and its status history unchanged. Retry after removing active attachments and waiting for terminating Instances to finish deleting. @Tags SpectrumXPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param spectrumXPartitionId path string true "ID of SpectrumXPartition" @Success 202 {object} model.APIMessageResponse @Router /v2/org/{org}/nico/spectrumx-partition/{spectrumXPartitionId} [delete]
type DeleteSubnetHandler ¶
type DeleteSubnetHandler struct {
// contains filtered or unexported fields
}
DeleteSubnetHandler is the API Handler for deleting a Subnet
func NewDeleteSubnetHandler ¶
func NewDeleteSubnetHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteSubnetHandler
NewDeleteSubnetHandler initializes and returns a new handler for deleting Subnet
func (DeleteSubnetHandler) Handle ¶
func (dsh DeleteSubnetHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing Subnet @Description Delete an existing Subnet @Tags Subnet @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Subnet" @Success 202 @Router /v2/org/{org}/nico/subnet/{id} [delete]
type DeleteTaskRuleHandler ¶
type DeleteTaskRuleHandler struct {
// contains filtered or unexported fields
}
DeleteTaskRuleHandler is the API Handler for deleting an Operation Rule.
Flow rejects deletion of rules that are still associated with racks or that are the active default for an operation. The caller must dissociate first; this handler surfaces the Flow error verbatim via UnwrapWorkflowError so the client gets a meaningful 4xx.
func NewDeleteTaskRuleHandler ¶
func NewDeleteTaskRuleHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteTaskRuleHandler
NewDeleteTaskRuleHandler initializes a new DeleteTaskRuleHandler.
func (DeleteTaskRuleHandler) Handle ¶
func (h DeleteTaskRuleHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an Operation Rule @Description Delete an Operation Rule by UUID. Rules associated with a rack or active as a default must be dissociated first. @Tags rule @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Rule" @Param siteId query string true "ID of the Site" @Success 204 "No Content" @Router /v2/org/{org}/nico/task/rule/{id} [delete]
type DeleteTenantAccountHandler ¶
type DeleteTenantAccountHandler struct {
// contains filtered or unexported fields
}
DeleteTenantAccountHandler is the API Handler for deleting a TenantAccount
func NewDeleteTenantAccountHandler ¶
func NewDeleteTenantAccountHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) DeleteTenantAccountHandler
NewDeleteTenantAccountHandler initializes and returns a new handler for deleting Tenant
func (DeleteTenantAccountHandler) Handle ¶
func (dtah DeleteTenantAccountHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing TenantAccount @Description Delete an existing TenantAccount @Tags tenantaccount @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Tenant Account" @Success 202 @Router /v2/org/{org}/nico/tenant/account/{id} [delete]
type DeleteTenantIdentityConfigHandler ¶
type DeleteTenantIdentityConfigHandler struct {
// contains filtered or unexported fields
}
DeleteTenantIdentityConfigHandler handles DELETE /tenant-identity/config.
func NewDeleteTenantIdentityConfigHandler ¶
func NewDeleteTenantIdentityConfigHandler(dbSession *cdb.Session, scp *sc.ClientPool) DeleteTenantIdentityConfigHandler
NewDeleteTenantIdentityConfigHandler returns a new DeleteTenantIdentityConfigHandler.
func (DeleteTenantIdentityConfigHandler) Handle ¶
func (dmich DeleteTenantIdentityConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete Tenant Identity Config @Description Remove the per-org tenant identity configuration and signing keys. In-flight tokens remain valid until natural expiry. @Tags TenantIdentity @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteID path string true "ID of Site" @Success 204 @Router /v2/org/{org}/nico/site/{siteID}/tenant-identity/config [delete]
type DeleteTenantIdentityTokenDelegationHandler ¶
type DeleteTenantIdentityTokenDelegationHandler struct {
// contains filtered or unexported fields
}
DeleteTenantIdentityTokenDelegationHandler handles DELETE /tenant-identity/token-delegation.
func NewDeleteTenantIdentityTokenDelegationHandler ¶
func NewDeleteTenantIdentityTokenDelegationHandler(dbSession *cdb.Session, scp *sc.ClientPool) DeleteTenantIdentityTokenDelegationHandler
NewDeleteTenantIdentityTokenDelegationHandler returns a new DeleteTenantIdentityTokenDelegationHandler.
func (DeleteTenantIdentityTokenDelegationHandler) Handle ¶
func (dtdh DeleteTenantIdentityTokenDelegationHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete Token Delegation @Description Remove the RFC 8693 token exchange callback. Subsequent Instance Metadata Service requests revert to direct token issuance. @Tags TenantIdentity @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteID path string true "ID of Site" @Success 204 @Router /v2/org/{org}/nico/site/{siteID}/tenant-identity/token-delegation [delete]
type DeleteTrayHealthReportHandler ¶
type DeleteTrayHealthReportHandler struct {
// contains filtered or unexported fields
}
DeleteTrayHealthReportHandler deletes a Tray health report.
func NewDeleteTrayHealthReportHandler ¶
func NewDeleteTrayHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) DeleteTrayHealthReportHandler
NewDeleteTrayHealthReportHandler returns a Tray health report remove handler.
func (DeleteTrayHealthReportHandler) Handle ¶
func (h DeleteTrayHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete Tray Health Report @Description Delete a Tray component health report override by source. @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Tray" @Param source path string true "Health report source" @Param siteId query string true "ID of Site" Format(uuid) @Param type query string true "Tray type" Enums(Compute,NVSwitch,PowerShelf) @Success 204 @Router /v2/org/{org}/nico/tray/{id}/health-report/{source} [delete]
type DeleteVPCHandler ¶
type DeleteVPCHandler struct {
// contains filtered or unexported fields
}
DeleteVPCHandler is the API Handler for deleting a VPC
func NewDeleteVPCHandler ¶
func NewDeleteVPCHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config, dps dpsclient.PowerProvisioner) DeleteVPCHandler
NewDeleteVPCHandler initializes and returns a new handler for deleting VPC
func (DeleteVPCHandler) Handle ¶
func (dvh DeleteVPCHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a VPC @Description Delete a VPC fro the org @Tags vpc @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of VPC" @Success 202 @Router /v2/org/{org}/nico/vpc/{id} [delete]
type DeleteVpcPeeringHandler ¶
type DeleteVpcPeeringHandler struct {
// contains filtered or unexported fields
}
DeleteVpcPeeringHandler is the API Handler for deleting a VPC Peering
func NewDeleteVpcPeeringHandler ¶
func NewDeleteVpcPeeringHandler(dbSession *cdb.Session, tc tclient.Client, sc *sc.ClientPool, cfg *config.Config) DeleteVpcPeeringHandler
NewDeleteVpcPeeringHandler initializes and returns a new handler for deleting VPC Peering
func (DeleteVpcPeeringHandler) Handle ¶
func (dvph DeleteVpcPeeringHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete a VPC Peering @Description Request VPC Peering deletion by ID. Poll GET until it returns 404 before deleting either VPC. @Tags vpcpeering @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of VPC Peering" @Success 202 {object} model.APIMessageResponse @Router /v2/org/{org}/nico/vpc-peering/{id} [delete]
type DeleteVpcPrefixHandler ¶
type DeleteVpcPrefixHandler struct {
// contains filtered or unexported fields
}
DeleteVpcPrefixHandler is the API Handler for deleting a VPC prefix
func NewDeleteVpcPrefixHandler ¶
func NewDeleteVpcPrefixHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) DeleteVpcPrefixHandler
NewDeleteVpcPrefixHandler initializes and returns a new handler for deleting VPC prefix
func (DeleteVpcPrefixHandler) Handle ¶
func (dsh DeleteVpcPrefixHandler) Handle(c echo.Context) error
Handle godoc @Summary Delete an existing VPC prefix @Description Delete an existing VPC prefix @Tags vpcprefix @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of VPC prefix" @Success 202 @Router /v2/org/{org}/nico/vpcprefix/{id} [delete]
type FactoryResetHandler ¶
type FactoryResetHandler struct {
// contains filtered or unexported fields
}
FactoryResetHandler shares authorization and site checks for tray/domain reset. Scope is fixed by route construction, never taken from request data.
func NewFactoryResetNVLinkDomainHandler ¶
func NewFactoryResetNVLinkDomainHandler(dbSession *cdb.Session, scp *sc.ClientPool) FactoryResetHandler
func NewFactoryResetTrayHandler ¶
func NewFactoryResetTrayHandler(dbSession *cdb.Session, scp *sc.ClientPool) FactoryResetHandler
type GetAllAllocationHandler ¶
type GetAllAllocationHandler struct {
// contains filtered or unexported fields
}
GetAllAllocationHandler is the API Handler for getting all Allocations
func NewGetAllAllocationHandler ¶
func NewGetAllAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllAllocationHandler
NewGetAllAllocationHandler initializes and returns a new handler for getting all Allocations
func (GetAllAllocationHandler) Handle ¶
func (gaah GetAllAllocationHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Allocations @Description Retrieve all Allocations relevant to current org @Tags Allocation @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param infrastructureProviderId query string false "Deprecated: ID of InfrastructureProvider" @Param tenantId query string false "Filter by Tenant ID (Provider role only; for Tenant role the tenant is inferred from org membership and this param is ignored)" @Param siteId query string false "ID of Site" @Param resourceType query string false "Filter by resource type e.g. 'InstanceType', 'IPBlock'" @Param resourceTypeId query string false "ID of ResourceType" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param constraintType query string false "Filter by constraint type e.g. 'Reserved', 'OnDemand', 'Preemptible'" @Param constraintValue query integer false "Filter by constraint value" @Param id query string false "ID of Allocation" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIAllocation @Router /v2/org/{org}/nico/allocation [get]
type GetAllAuditEntryHandler ¶
type GetAllAuditEntryHandler struct {
// contains filtered or unexported fields
}
GetAllAuditEntryHandler is the API Handler for retrieving all AuditEntries
func NewGetAllAuditEntryHandler ¶
func NewGetAllAuditEntryHandler(dbSession *cdb.Session) GetAllAuditEntryHandler
NewGetAllAuditEntryHandler initializes and returns a new handler for retrieving all AuditEntries
func (GetAllAuditEntryHandler) Handle ¶
func (gaaeh GetAllAuditEntryHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all AuditEntries @Description Get all AuditEntries in the org @Tags audit @Accept json @Produce json @Security ApiKeyAuth @Success 200 {array} []model.APIAuditEntry @Router /v2/org/{org}/nico/audit [get]
type GetAllDerivedIPBlockHandler ¶
type GetAllDerivedIPBlockHandler struct {
// contains filtered or unexported fields
}
GetAllDerivedIPBlockHandler is the API Handler for getting details of derived IPBlocks from a parent IPBlock
func NewGetAllDerivedIPBlockHandler ¶
func NewGetAllDerivedIPBlockHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllDerivedIPBlockHandler
NewGetAllDerivedIPBlockHandler initializes and returns a new handler for getting derived IPBlocks
func (GetAllDerivedIPBlockHandler) Handle ¶
func (gadipbh GetAllDerivedIPBlockHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Derived IPBlocks @Description Get all Derived IPBlocks for a given parent IPBlock @Tags IPBlock @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of IPBlock" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Success 200 {object} model.APIIPBlock @Router /v2/org/{org}/nico/ipblock/{id}/derived [get]
type GetAllDpuExtensionServiceHandler ¶
type GetAllDpuExtensionServiceHandler struct {
// contains filtered or unexported fields
}
GetAllDpuExtensionServiceHandler is the API Handler for getting all DPU Extension Services
func NewGetAllDpuExtensionServiceHandler ¶
func NewGetAllDpuExtensionServiceHandler(dbSession *cdb.Session, tc tclient.Client, cfg *config.Config) GetAllDpuExtensionServiceHandler
NewGetAllDpuExtensionServiceHandler initializes and returns a new handler for getting all DPU Extension Services
func (GetAllDpuExtensionServiceHandler) Handle ¶
func (gadesh GetAllDpuExtensionServiceHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all DPU Extension Services @Description Get all DPU Extension Services for the current Tenant @Tags DPU Extension Service @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "Filter by Site ID" @Param status query string false "Filter by Status" @Param query query string false "Search query for name, description and status" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Tenant'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} model.APIDpuExtensionService @Router /v2/org/{org}/nico/dpu-extension-service [get]
type GetAllDpuMachineHandler ¶
type GetAllDpuMachineHandler struct {
// contains filtered or unexported fields
}
GetAllDpuMachineHandler is the API Handler for retrieving DPU machines attached to a host Machine.
func NewGetAllDpuMachineHandler ¶
func NewGetAllDpuMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetAllDpuMachineHandler
NewGetAllDpuMachineHandler initializes and returns a new handler to retrieve Machine DPU machines.
func (GetAllDpuMachineHandler) Handle ¶
func (gadmh GetAllDpuMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve DPU machines attached to a host Machine @Description Retrieve DPU machines attached to a host Machine via a synchronous Temporal workflow. See the OpenAPI spec for full authorization and response details. @Tags Machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param machineId path string true "ID of host Machine" @Success 200 {object} []model.APIDpuMachine @Router /v2/org/{org}/nico/machine/{machineId}/dpu [get]
type GetAllDpuMachinesHandler ¶
type GetAllDpuMachinesHandler struct {
// contains filtered or unexported fields
}
GetAllDpuMachinesHandler lists DPU machines for a Site via Core.
func NewGetAllDpuMachinesHandler ¶
func NewGetAllDpuMachinesHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetAllDpuMachinesHandler
NewGetAllDpuMachinesHandler returns a handler for listing DPU machines.
func (GetAllDpuMachinesHandler) Handle ¶
func (gadmh GetAllDpuMachinesHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all DPU Machines for a Site @Description Retrieve DPU Machines for a Site, ordered by DPU Machine ID. Network configuration is null because the bulk Core Machine response does not include it. @Tags Machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "DPU Machine ID ordering" Enums(ID_ASC, ID_DESC) default(ID_ASC) @Success 200 {array} model.APIDpuMachine @Router /v2/org/{org}/nico/dpu [get]
type GetAllExpectedMachineHandler ¶
type GetAllExpectedMachineHandler struct {
// contains filtered or unexported fields
}
GetAllExpectedMachineHandler is the API Handler for getting all ExpectedMachines
func NewGetAllExpectedMachineHandler ¶
func NewGetAllExpectedMachineHandler(dbSession *cdb.Session, cfg *config.Config) GetAllExpectedMachineHandler
NewGetAllExpectedMachineHandler initializes and returns a new handler for getting all ExpectedMachines
func (GetAllExpectedMachineHandler) Handle ¶
func (gaemh GetAllExpectedMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all ExpectedMachines @Description Get all ExpectedMachines. Tenant results are restricted to Sites with effective TargetedInstanceCreation; no single-Site privilege scope is required. @Tags ExpectedMachine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site (optional, filters results to specific site)" @Param pageNumber query integer false "Page number of results returned" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'SKU'" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIExpectedMachine @Router /v2/org/{org}/nico/expected-machine [get]
type GetAllExpectedMachineLabelKeyHandler ¶
type GetAllExpectedMachineLabelKeyHandler struct {
// contains filtered or unexported fields
}
GetAllExpectedMachineLabelKeyHandler lists ExpectedMachine label keys.
func NewGetAllExpectedMachineLabelKeyHandler ¶
func NewGetAllExpectedMachineLabelKeyHandler(dbSession *cdb.Session) GetAllExpectedMachineLabelKeyHandler
NewGetAllExpectedMachineLabelKeyHandler initializes an ExpectedMachine label-key list handler.
func (GetAllExpectedMachineLabelKeyHandler) Handle ¶
func (h GetAllExpectedMachineLabelKeyHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all ExpectedMachine label keys @Tags ExpectedMachine @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Label key ordering" Enums(KEY_ASC, KEY_DESC) default(KEY_ASC) @Success 200 {array} string @Router /v2/org/{org}/nico/expected-machine/label/key [get]
type GetAllExpectedMachineLabelValueHandler ¶
type GetAllExpectedMachineLabelValueHandler struct {
// contains filtered or unexported fields
}
GetAllExpectedMachineLabelValueHandler lists values for an ExpectedMachine label key.
func NewGetAllExpectedMachineLabelValueHandler ¶
func NewGetAllExpectedMachineLabelValueHandler(dbSession *cdb.Session) GetAllExpectedMachineLabelValueHandler
NewGetAllExpectedMachineLabelValueHandler initializes an ExpectedMachine label-value list handler.
func (GetAllExpectedMachineLabelValueHandler) Handle ¶
func (h GetAllExpectedMachineLabelValueHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all values for an ExpectedMachine label key @Tags ExpectedMachine @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param key path string true "Label key" @Param siteId query string false "ID of Site" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Label value ordering" Enums(VALUE_ASC, VALUE_DESC) default(VALUE_ASC) @Success 200 {array} string @Router /v2/org/{org}/nico/expected-machine/label/key/{key}/value [get]
type GetAllExpectedPowerShelfHandler ¶
type GetAllExpectedPowerShelfHandler struct {
// contains filtered or unexported fields
}
GetAllExpectedPowerShelfHandler is the API Handler for getting all ExpectedPowerShelves
func NewGetAllExpectedPowerShelfHandler ¶
func NewGetAllExpectedPowerShelfHandler(dbSession *cdb.Session, cfg *config.Config) GetAllExpectedPowerShelfHandler
NewGetAllExpectedPowerShelfHandler initializes and returns a new handler for getting all ExpectedPowerShelves
func (GetAllExpectedPowerShelfHandler) Handle ¶
func (gaepsh GetAllExpectedPowerShelfHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all ExpectedPowerShelves @Description Get all ExpectedPowerShelves. Provider callers may omit siteId to list across their Sites; Tenant callers must specify siteId. @Tags ExpectedPowerShelf @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site (optional, filters results to specific site)" @Param pageNumber query integer false "Page number of results returned" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIExpectedPowerShelf @Router /v2/org/{org}/nico/expected-power-shelf [get]
type GetAllExpectedRackGroupHandler ¶
type GetAllExpectedRackGroupHandler struct {
// contains filtered or unexported fields
}
GetAllExpectedRackGroupHandler is the API Handler for getting all ExpectedRackGroups
func NewGetAllExpectedRackGroupHandler ¶
func NewGetAllExpectedRackGroupHandler(dbSession *cdb.Session, cfg *config.Config) GetAllExpectedRackGroupHandler
NewGetAllExpectedRackGroupHandler initializes and returns a new handler for getting all ExpectedRackGroups
func (GetAllExpectedRackGroupHandler) Handle ¶
func (gaerh GetAllExpectedRackGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all ExpectedRackGroups @Description Get all ExpectedRackGroups. Provider callers may omit siteId to list across their Sites; Tenant callers must specify siteId. @Tags ExpectedRackGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site (optional, filters results to specific site)" @Param pageNumber query integer false "Page number of results returned" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIExpectedRackGroup @Router /v2/org/{org}/nico/expected-rack-group [get]
type GetAllExpectedRackHandler ¶
type GetAllExpectedRackHandler struct {
// contains filtered or unexported fields
}
GetAllExpectedRackHandler is the API Handler for getting all ExpectedRacks
func NewGetAllExpectedRackHandler ¶
func NewGetAllExpectedRackHandler(dbSession *cdb.Session, cfg *config.Config) GetAllExpectedRackHandler
NewGetAllExpectedRackHandler initializes and returns a new handler for getting all ExpectedRacks
func (GetAllExpectedRackHandler) Handle ¶
func (gaerh GetAllExpectedRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all ExpectedRacks @Description Get all ExpectedRacks. Provider callers may omit siteId to list across their Sites; Tenant callers must specify siteId. @Tags ExpectedRack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site (optional, filters results to specific site)" @Param pageNumber query integer false "Page number of results returned" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIExpectedRack @Router /v2/org/{org}/expected-rack [get]
type GetAllExpectedSwitchHandler ¶
type GetAllExpectedSwitchHandler struct {
// contains filtered or unexported fields
}
GetAllExpectedSwitchHandler is the API Handler for getting all ExpectedSwitches
func NewGetAllExpectedSwitchHandler ¶
func NewGetAllExpectedSwitchHandler(dbSession *cdb.Session, cfg *config.Config) GetAllExpectedSwitchHandler
NewGetAllExpectedSwitchHandler initializes and returns a new handler for getting all ExpectedSwitches
func (GetAllExpectedSwitchHandler) Handle ¶
func (gaesh GetAllExpectedSwitchHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all ExpectedSwitches @Description Get all ExpectedSwitches. Provider callers may omit siteId to list across their Sites; Tenant callers must specify siteId. @Tags ExpectedSwitch @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site (optional, filters results to specific site)" @Param pageNumber query integer false "Page number of results returned" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIExpectedSwitch @Router /v2/org/{org}/nico/expected-switch [get]
type GetAllExploredEndpointHandler ¶
type GetAllExploredEndpointHandler struct {
// contains filtered or unexported fields
}
GetAllExploredEndpointHandler lists explored endpoints for a Site via Core.
func NewGetAllExploredEndpointHandler ¶
func NewGetAllExploredEndpointHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) GetAllExploredEndpointHandler
NewGetAllExploredEndpointHandler returns a handler for listing explored endpoints.
func (GetAllExploredEndpointHandler) Handle ¶
func (h GetAllExploredEndpointHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Explored Endpoints @Description Retrieve explored endpoints discovered by Site Explorer for a Site, ordered by endpoint ID. @Tags site-explorer @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param machineId query string false "Filter reports by Machine ID" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Endpoint ID ordering" Enums(ID_ASC, ID_DESC) default(ID_ASC) @Success 200 {array} model.APIExploredEndpoint @Router /v2/org/{org}/nico/site-explorer/endpoint [get]
type GetAllFabricHandler ¶
type GetAllFabricHandler struct {
// contains filtered or unexported fields
}
GetAllFabricHandler is the API Handler for getting all Fabrics
func NewGetAllFabricHandler ¶
func NewGetAllFabricHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllFabricHandler
NewGetAllFabricHandler initializes and returns a new handler for getting all Fabrics
func (GetAllFabricHandler) Handle ¶
func (gafh GetAllFabricHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Fabrics @Description Retrieve all Fabrics for Sites owned by the org. Endpoint is currently not exposed to users @Tags Fabric @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Site'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIFabric @Router /v2/org/{org}/nico/site/{siteId}/fabric [get]
type GetAllIPBlockHandler ¶
type GetAllIPBlockHandler struct {
// contains filtered or unexported fields
}
GetAllIPBlockHandler is the API Handler for getting all IPBlocks
func NewGetAllIPBlockHandler ¶
func NewGetAllIPBlockHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllIPBlockHandler
NewGetAllIPBlockHandler initializes and returns a new handler for getting all IPBlocks
func (GetAllIPBlockHandler) Handle ¶
func (gaipbh GetAllIPBlockHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all IPBlocks @Description Get all IPBlocks @Tags IPBlock @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param infrastructureProviderId query string false "Deprecated: Infrastructure Provider is now inferred from the org's membership" @Param tenantId query string false "Deprecated: Tenant is now inferred from the org's membership" @Param siteId query string true "ID of Site" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Param includeUsageStats query boolean false "IPBlock usage stats to include in response @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIIPBlock @Router /v2/org/{org}/nico/ipblock [get]
type GetAllInfiniBandInterfaceHandler ¶
type GetAllInfiniBandInterfaceHandler struct {
// contains filtered or unexported fields
}
GetAllInfiniBandInterfaceHandler is the API Handler for retrieving all InfiniBandInterfaces
func NewGetAllInfiniBandInterfaceHandler ¶
func NewGetAllInfiniBandInterfaceHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config, queryOverride ...*common.QueryOverride) GetAllInfiniBandInterfaceHandler
NewGetAllInfiniBandInterfaceHandler initializes and returns a new handler for retrieving all InfiniBandInterfaces. When queryOverride is provided (e.g. when delegating from instance-scoped endpoint), it supplies values that would otherwise come from query params, and error messages use "path" instead of "query".
func (GetAllInfiniBandInterfaceHandler) Handle ¶
func (gaibih GetAllInfiniBandInterfaceHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all InfiniBandInterfaces @Description Retrieve all InfiniBandInterfaces @Tags InfiniBandInterface @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param instanceId path string true "ID of Instance" @Param infinibandPartitionId path string true "ID of InfiniBandPartition" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param includeRelation query string false "Related entities to include in response e.g. 'InfiniBandPartition, Instance'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} model.APIInfiniBandInterface @Router /v2/org/{org}/nico/infiniband-interface [get]
type GetAllInfiniBandPartitionHandler ¶
type GetAllInfiniBandPartitionHandler struct {
// contains filtered or unexported fields
}
GetAllInfiniBandPartitionHandler is the API Handler for getting all InfiniBandPartitions
func NewGetAllInfiniBandPartitionHandler ¶
func NewGetAllInfiniBandPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllInfiniBandPartitionHandler
NewGetAllInfiniBandPartitionHandler initializes and returns a new handler for getting all InfiniBandPartitions
func (GetAllInfiniBandPartitionHandler) Handle ¶
func (gaibph GetAllInfiniBandPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all InfiniBandPartitions @Description Get all InfiniBandPartitions @Tags InfiniBandPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIInfiniBandPartition @Router /v2/org/{org}/nico/infiniband-partition [get]
type GetAllInstanceHandler ¶
type GetAllInstanceHandler struct {
// contains filtered or unexported fields
}
GetAllInstanceHandler is the API Handler for retrieving all Instances
func NewGetAllInstanceHandler ¶
func NewGetAllInstanceHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllInstanceHandler
NewGetAllInstanceHandler initializes and returns a new handler for retreiving all Instances
func (GetAllInstanceHandler) Handle ¶
func (gaih GetAllInstanceHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Instances @Description Get all Instances for the org @Tags Instance @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param infrastructureProviderId query string false "Deprecated: Instances will no longer be filtered by Infrastructure Provider; results are scoped to the org's Tenant. Use siteId to scope results to a specific Infrastructure Provider's Sites." @Param siteId query string true "ID of Site" @Param vpcId query string true "ID of Vpc" @Param instanceTypeId query string false "ID of Instance Type" @Param operatingSystemId query string false "ID of Operating System" @Param name query string false "Filter by Instance name" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param ipAddress query string false "Filter by IP address. Can be specified multiple times to filter on more than one IP address." @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} []model.APIInstance @Router /v2/org/{org}/nico/instance [get]
type GetAllInstanceInfiniBandInterfaceHandler ¶
type GetAllInstanceInfiniBandInterfaceHandler struct {
// contains filtered or unexported fields
}
GetAllInstanceInfiniBandInterfaceHandler is the API Handler for retrieving all InfiniBandInterfaces for an Instance
func NewGetAllInstanceInfiniBandInterfaceHandler ¶
func NewGetAllInstanceInfiniBandInterfaceHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllInstanceInfiniBandInterfaceHandler
NewGetAllInstanceInfiniBandInterfaceHandler initializes and returns a new handler for retrieving all InfiniBandInterfaces for an Instance
func (GetAllInstanceInfiniBandInterfaceHandler) Handle ¶
func (gaiibih GetAllInstanceInfiniBandInterfaceHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Interfaces for an Instance @Description Retrieve all Interfaces for an Instance @Tags interface @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param instanceId path string true "ID of Instance" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param includeRelation query string false "Related entities to include in response e.g. 'Instance', 'Subnet'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} model.APIInterface @Router /v2/org/{org}/nico/instance/{instance_id}/interface [get]
type GetAllInstanceInterfaceHandler ¶
type GetAllInstanceInterfaceHandler struct {
// contains filtered or unexported fields
}
GetAllInstanceInterfaceHandler is the API Handler for retrieving all Interfaces for an Instance.
func NewGetAllInstanceInterfaceHandler ¶
func NewGetAllInstanceInterfaceHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllInstanceInterfaceHandler
NewGetAllInstanceInterfaceHandler initializes an Instance-scoped Interface handler.
func (GetAllInstanceInterfaceHandler) Handle ¶
func (h GetAllInstanceInterfaceHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Interfaces for an Instance @Description Retrieve all Interfaces for an Instance @Tags interface @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param instanceId path string true "ID of Instance" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param includeRelation query string false "Related entities to include in response e.g. 'Instance', 'Subnet'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} model.APIInterface @Router /v2/org/{org}/nico/instance/{instance_id}/interface [get]
type GetAllInstanceNVLinkInterfaceHandler ¶
type GetAllInstanceNVLinkInterfaceHandler struct {
// contains filtered or unexported fields
}
GetAllInstanceNVLinkInterfaceHandler is the API Handler for retrieving all NVLinkInterfaces for an Instance
func NewGetAllInstanceNVLinkInterfaceHandler ¶
func NewGetAllInstanceNVLinkInterfaceHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllInstanceNVLinkInterfaceHandler
NewGetAllInstanceNVLinkInterfaceHandler initializes and returns a new handler for retrieving all NVLinkInterfaces for an Instance
func (GetAllInstanceNVLinkInterfaceHandler) Handle ¶
func (ganvliih GetAllInstanceNVLinkInterfaceHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Interfaces for an Instance @Description Retrieve all Interfaces for an Instance @Tags interface @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param instanceId path string true "ID of Instance" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param includeRelation query string false "Related entities to include in response e.g. 'Instance', 'Subnet'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} model.APIInterface @Router /v2/org/{org}/nico/instance/{instance_id}/interface [get]
type GetAllInstanceTypeHandler ¶
type GetAllInstanceTypeHandler struct {
// contains filtered or unexported fields
}
GetAllInstanceTypeHandler is the API Handler for getting all Instance Types
func NewGetAllInstanceTypeHandler ¶
func NewGetAllInstanceTypeHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllInstanceTypeHandler
NewGetAllInstanceTypeHandler initializes and returns a new handler for getting all Instance Types
func (GetAllInstanceTypeHandler) Handle ¶
func (gaith GetAllInstanceTypeHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Instance Types @Description Get all Instance Types relevant to current org @Tags instancetype @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site" @Param infrastructureProviderId query string false "Deprecated: ID of Infrastructure Provider" @Param tenantId query string false "Deprecated: ID of Tenant" @Param status query string false "Query input for status" @Param query query string false "Query input for full text search" @Param includeAllocationStats query boolean false "Allocation stats to include in response" @Param includeMachineAssignment query boolean false "Machine associations entity to include in response (Provider only)" @Param excludeUnallocated query boolean false "Exclude unallocated Instance Types (Tenant only)" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIInstanceType @Router /v2/org/{org}/nico/instance/type [get]
type GetAllInterfaceHandler ¶
type GetAllInterfaceHandler struct {
// contains filtered or unexported fields
}
GetAllInterfaceHandler is the API Handler for retrieving Tenant-visible Interfaces.
func NewGetAllInterfaceHandler ¶
func NewGetAllInterfaceHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config, queryOverride ...*common.QueryOverride) GetAllInterfaceHandler
NewGetAllInterfaceHandler initializes an Interface handler. A query override supplies path-scoped values when the Instance endpoint delegates to the general endpoint.
func (GetAllInterfaceHandler) Handle ¶
func (gaish GetAllInterfaceHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve Tenant-visible Interfaces @Description Retrieve Interfaces visible to the current Tenant @Tags Interface @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param vpcId query string false "Filter by attached VPC ID" @Param crossTenant query boolean false "Filter by whether the Instance and selected VPC or VPC Prefix have different owning Tenants" @Param instanceTenantId query string false "Filter by Instance owning Tenant ID" @Param vpcTenantId query string false "Filter by selected VPC or VPC Prefix owning Tenant ID" @Param status query string false "Filter by status" @Param includeRelation query string false "Related entities to include in response" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} model.APIInterface @Router /v2/org/{org}/nico/interface [get]
type GetAllIpxeTemplateHandler ¶
type GetAllIpxeTemplateHandler struct {
// contains filtered or unexported fields
}
GetAllIpxeTemplateHandler is the API Handler for getting all iPXE templates
func NewGetAllIpxeTemplateHandler ¶
func NewGetAllIpxeTemplateHandler(dbSession *cdb.Session, tc tclient.Client, cfg *config.Config) GetAllIpxeTemplateHandler
NewGetAllIpxeTemplateHandler initializes and returns a new handler for getting all iPXE templates
func (GetAllIpxeTemplateHandler) Handle ¶
func (h GetAllIpxeTemplateHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all iPXE templates @Description Get all iPXE templates propagated from nico-core. Templates are global (one row per stable core template UUID); per-site availability is recorded internally. The `siteId` query parameter is optional and may be repeated to restrict results to templates available at one or more sites. When omitted, a Provider Admin/Viewer receives templates available at any site owned by their infrastructure provider; a Tenant Admin receives templates available at any site whose provider the tenant has a Tenant Account on. @Tags iPXE Template @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query []string false "Optional site ID(s); may be repeated to restrict results to templates available at any of the sites" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIIpxeTemplate @Router /v2/org/{org}/nico/ipxe-template [get]
type GetAllMachineCapabilityHandler ¶
type GetAllMachineCapabilityHandler struct {
// contains filtered or unexported fields
}
GetAllMachineCapabilityHandler is an API Handler to return various Machine Capabilities
func NewGetAllMachineCapabilityHandler ¶
func NewGetAllMachineCapabilityHandler(dbSession *cdb.Session) GetAllMachineCapabilityHandler
NewGetAllMachineCapabilityHandler creates and returns a new handler for retrieving Machine Capabilities
func (GetAllMachineCapabilityHandler) Handle ¶
func (gamch GetAllMachineCapabilityHandler) Handle(c echo.Context) error
Handle godoc @Summary Return information about the current user @Description Get basic information about the user making the request @Tags user @Accept */* @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param site_id query string true "Filter by site ID" @Success 200 {object} model.APIUser @Router /v2/org/{org}/nico/machine-capability [get]
type GetAllMachineHandler ¶
type GetAllMachineHandler struct {
// contains filtered or unexported fields
}
GetAllMachineHandler is the API Handler for getting all Machines
func NewGetAllMachineHandler ¶
func NewGetAllMachineHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllMachineHandler
NewGetAllMachineHandler initializes and returns a new handler for getting all Machines
func (GetAllMachineHandler) Handle ¶
func (gamh GetAllMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Machines @Description Get all Machines. Tenant results are restricted to Sites with effective TargetedInstanceCreation; no single-Site privilege scope is required. @Tags Machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param id query []string false "Filter by Machine IDs" collectionFormat(multi) @Param hasInstance query boolean false "Filter Machines by whether machine is assigned to an Instance." @Param hasInstanceType query boolean false "Filter by assigned an InstanceType to include in response" @Param instanceTypeId query []string false "Filter by Instance Type IDs" collectionFormat(multi) @Param tenantId query []string false "Filter by Tenant IDs" collectionFormat(multi) @Param capabilityType query string true "Filter by CapabilityType" e.g "'InfiniBand', 'CPU'" @Param capabilityName query []string false "Filter by Capability Names" collectionFormat(multi) @Param status query []string false "Filter by Machine Statuses" collectionFormat(multi) @Param hwSkuDeviceType query []string false "Filter by hardware SKU Device Types" collectionFormat(multi) @Param query query string false "Query input for full text search" @Param includeMetadata query boolean false "Include metadata info in response" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Site', 'InstanceType'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIMachine @Router /v2/org/{org}/nico/machine [get]
type GetAllMachineHealthReportHandler ¶
type GetAllMachineHealthReportHandler struct {
// contains filtered or unexported fields
}
GetAllMachineHealthReportHandler lists all health reports for a given Machine
func NewGetAllMachineHealthReportHandler ¶
func NewGetAllMachineHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) GetAllMachineHealthReportHandler
NewGetAllMachineHealthReportHandler returns a new GetAllMachineHealthReportHandler
func (GetAllMachineHealthReportHandler) Handle ¶
func (h GetAllMachineHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Machine Health Reports @Description Get all health report overrides for a Machine. @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Success 200 {array} model.APIMachineHealthReportEntry @Router /v2/org/{org}/nico/machine/{machineId}/health-report [get]
type GetAllMachineInstanceTypeHandler ¶
type GetAllMachineInstanceTypeHandler struct {
// contains filtered or unexported fields
}
GetAllMachineInstanceTypeHandler is the API Handler for getting all Instance Types
func NewGetAllMachineInstanceTypeHandler ¶
func NewGetAllMachineInstanceTypeHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllMachineInstanceTypeHandler
NewGetAllMachineInstanceTypeHandler initializes and returns a new handler for getting all Instance Types
func (GetAllMachineInstanceTypeHandler) Handle ¶
func (gamith GetAllMachineInstanceTypeHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Machine/Instance Types associations @Description Get all Machine/Instance Types associations for Instance Type @Tags machineinstancetype @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param instance_type_id query string true "ID of Instance Type" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIMachineInstanceType @Router /v2/org/{org}/nico/instance/type/{instance_type_id}/machine [get]
type GetAllMachineLabelKeyHandler ¶
type GetAllMachineLabelKeyHandler struct {
// contains filtered or unexported fields
}
GetAllMachineLabelKeyHandler lists Machine label keys.
func NewGetAllMachineLabelKeyHandler ¶
func NewGetAllMachineLabelKeyHandler(dbSession *cdb.Session) GetAllMachineLabelKeyHandler
NewGetAllMachineLabelKeyHandler initializes a Machine label-key list handler.
func (GetAllMachineLabelKeyHandler) Handle ¶
func (h GetAllMachineLabelKeyHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Machine label keys @Tags Machine @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Label key ordering" Enums(KEY_ASC, KEY_DESC) default(KEY_ASC) @Success 200 {array} string @Router /v2/org/{org}/nico/machine/label/key [get]
type GetAllMachineLabelValueHandler ¶
type GetAllMachineLabelValueHandler struct {
// contains filtered or unexported fields
}
GetAllMachineLabelValueHandler lists values for a Machine label key.
func NewGetAllMachineLabelValueHandler ¶
func NewGetAllMachineLabelValueHandler(dbSession *cdb.Session) GetAllMachineLabelValueHandler
NewGetAllMachineLabelValueHandler initializes a Machine label-value list handler.
func (GetAllMachineLabelValueHandler) Handle ¶
func (h GetAllMachineLabelValueHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all values for a Machine label key @Tags Machine @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param key path string true "Label key" @Param siteId query string false "ID of Site" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Label value ordering" Enums(VALUE_ASC, VALUE_DESC) default(VALUE_ASC) @Success 200 {array} string @Router /v2/org/{org}/nico/machine/label/key/{key}/value [get]
type GetAllMachineValidationExternalConfigHandler ¶
type GetAllMachineValidationExternalConfigHandler struct {
// contains filtered or unexported fields
}
GetAllMachineValidationExternalConfigHandler is the API Handler to get all MachineValidationExternalConfigs
func NewGetAllMachineValidationExternalConfigHandler ¶
func NewGetAllMachineValidationExternalConfigHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllMachineValidationExternalConfigHandler
NewGetAllMachineValidationExternalConfigHandler initializes and returns a new handler to get all MachineValidationExternalConfigs
func (GetAllMachineValidationExternalConfigHandler) Handle ¶
func (handler GetAllMachineValidationExternalConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all MachineValidationExternalConfigs @Description Get all MachineValidationExternalConfigs @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} []model.APIMachineValidationExternalConfig @Router /v2/org/{org}/nico/site/{site}/machine-validation/external-config [get]
type GetAllMachineValidationRunHandler ¶
type GetAllMachineValidationRunHandler struct {
// contains filtered or unexported fields
}
GetAllMachineValidationRunHandler is the API Handler to get all MachineValidationRuns
func NewGetAllMachineValidationRunHandler ¶
func NewGetAllMachineValidationRunHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllMachineValidationRunHandler
NewGetAllMachineValidationRunHandler initializes and returns a new handler to get all MachineValidationRuns
func (GetAllMachineValidationRunHandler) Handle ¶
func (handler GetAllMachineValidationRunHandler) Handle(c echo.Context) error
Handle godoc @Summary Get Machine validation runs @Description Get Machine validation runs @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param machineId path string true "ID of Machine" @Success 200 {object} []model.APIMachineValidationRun @Router /v2/org/{org}/nico/machine/{machineId}/validation/run [get]
type GetAllMachineValidationTestHandler ¶
type GetAllMachineValidationTestHandler struct {
// contains filtered or unexported fields
}
GetAllMachineValidationTestHandler is the API Handler to get all MachineValidationTests
func NewGetAllMachineValidationTestHandler ¶
func NewGetAllMachineValidationTestHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllMachineValidationTestHandler
NewGetAllMachineValidationTestHandler initializes and returns a new handler to get all MachineValidationTests
func (GetAllMachineValidationTestHandler) Handle ¶
func (handler GetAllMachineValidationTestHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all MachineValidationTests @Description Get all MachineValidationTests @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} []model.APIMachineValidationTest @Router /v2/org/{org}/nico/site/{site}/machine-validation/test [get]
type GetAllMeasuredBootTrustedMachineHandler ¶
type GetAllMeasuredBootTrustedMachineHandler struct {
// contains filtered or unexported fields
}
GetAllMeasuredBootTrustedMachineHandler lists machine trust approvals.
func NewGetAllMeasuredBootTrustedMachineHandler ¶
func NewGetAllMeasuredBootTrustedMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetAllMeasuredBootTrustedMachineHandler
NewGetAllMeasuredBootTrustedMachineHandler returns a machine trust approval list handler.
type GetAllMeasuredBootTrustedProfileHandler ¶
type GetAllMeasuredBootTrustedProfileHandler struct {
// contains filtered or unexported fields
}
GetAllMeasuredBootTrustedProfileHandler lists profile trust approvals.
func NewGetAllMeasuredBootTrustedProfileHandler ¶
func NewGetAllMeasuredBootTrustedProfileHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetAllMeasuredBootTrustedProfileHandler
NewGetAllMeasuredBootTrustedProfileHandler returns a profile trust approval list handler.
type GetAllNVLinkDomainHandler ¶
type GetAllNVLinkDomainHandler struct {
// contains filtered or unexported fields
}
GetAllNVLinkDomainHandler is the API Handler for getting all NVLink Domains
func NewGetAllNVLinkDomainHandler ¶
func NewGetAllNVLinkDomainHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllNVLinkDomainHandler
NewGetAllNVLinkDomainHandler initializes and returns a new handler for getting all NVLink Domains
func (GetAllNVLinkDomainHandler) Handle ¶
func (gandh GetAllNVLinkDomainHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all NVLink Domains @Description Get all NVLink Domains with optional filters @Tags Domain @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of the Site" @Param includeComponents query boolean false "Include domain components in response" @Param name query string false "Filter by domain name" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} model.APINVLinkDomain @Router /v2/org/{org}/nico/domain/nvlink [get]
type GetAllNVLinkInterfaceHandler ¶
type GetAllNVLinkInterfaceHandler struct {
// contains filtered or unexported fields
}
GetAllNVLinkInterfaceHandler is the API Handler for retrieving all NVLinkInterfaces
func NewGetAllNVLinkInterfaceHandler ¶
func NewGetAllNVLinkInterfaceHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config, queryOverride ...*common.QueryOverride) GetAllNVLinkInterfaceHandler
NewGetAllNVLinkInterfaceHandler initializes and returns a new handler for retrieving all NVLinkInterfaces. When queryOverride is provided (e.g. when delegating from instance-scoped endpoint), it supplies values that would otherwise come from query params, and error messages use "request" instead of "query".
func (GetAllNVLinkInterfaceHandler) Handle ¶
func (gaish GetAllNVLinkInterfaceHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all NVLinkInterfaces @Description Retrieve all NVLinkInterfaces @Tags NVLinkInterface @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param instanceId path string true "ID of Instance" @Param nvlinkLogicalPartitionId path string true "ID of NVLinkLogicalPartition" @Param nvLinkDomainId path string true "ID of NVLinkDomain" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param includeRelation query string false "Related entities to include in response e.g. 'NVLinkLogicalPartition, Instance'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} model.APINVLinkInterface @Router /v2/org/{org}/nico/nvlink-interface [get]
type GetAllNVLinkLogicalPartitionHandler ¶
type GetAllNVLinkLogicalPartitionHandler struct {
// contains filtered or unexported fields
}
GetAllNVLinkLogicalPartitionHandler is the API Handler for getting all NVLinkLogicalPartitions
func NewGetAllNVLinkLogicalPartitionHandler ¶
func NewGetAllNVLinkLogicalPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllNVLinkLogicalPartitionHandler
NewGetAllNVLinkLogicalPartitionHandler initializes and returns a new handler for getting all NVLinkLogicalPartitions
func (GetAllNVLinkLogicalPartitionHandler) Handle ¶
func (gaibph GetAllNVLinkLogicalPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all NVLinkLogicalPartitions @Description Get all NVLinkLogicalPartitions @Tags NVLinkLogicalPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant'" @Param includeInterfaces query boolean false "Include NVLinkInterfaces in response" @Param includeStats query boolean false "Include NVLinkLogicalPartitionStats in response" @Param includeVpcs query boolean false "Include VPCs in response" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APINVLinkLogicalPartition @Router /v2/org/{org}/nico/nvlink-logical-partition [get]
type GetAllNetworkSecurityGroupHandler ¶
type GetAllNetworkSecurityGroupHandler struct {
// contains filtered or unexported fields
}
GetAllNetworkSecurityGroupHandler is the API Handler for getting all NetworkSecurityGroups
func NewGetAllNetworkSecurityGroupHandler ¶
func NewGetAllNetworkSecurityGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllNetworkSecurityGroupHandler
NewGetAllNetworkSecurityGroupHandler initializes and returns a new handler for getting all NetworkSecurityGroups
func (GetAllNetworkSecurityGroupHandler) Handle ¶
func (gansgh GetAllNetworkSecurityGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all NetworkSecurityGroups @Description Get all NetworkSecurityGroups for a given Site @Tags networksecuritygroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param status query string false "Query input for status" @Param query query string false "Query input for full text search" @Param includeAttachmentStats query boolean false "Attachment stats to include in response" @Param includeRelation query string false "Related entities to include in response e.g. 'Tenant', 'Site'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APINetworkSecurityGroup @Router /v2/org/{org}/nico/network-security-group [get]
type GetAllOperatingSystemHandler ¶
type GetAllOperatingSystemHandler struct {
// contains filtered or unexported fields
}
GetAllOperatingSystemHandler is the API Handler for getting all OperatingSystems
func NewGetAllOperatingSystemHandler ¶
func NewGetAllOperatingSystemHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllOperatingSystemHandler
NewGetAllOperatingSystemHandler initializes and returns a new handler for getting all OperatingSystems
func (GetAllOperatingSystemHandler) Handle ¶
func (gash GetAllOperatingSystemHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all OperatingSystems @Description Get all OperatingSystems @Tags OperatingSystem @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param type query string true "type of Operating System" e.g. 'iPXE', 'Image'" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIOperatingSystem @Router /v2/org/{org}/nico/operating-system [get]
type GetAllRackHandler ¶
type GetAllRackHandler struct {
// contains filtered or unexported fields
}
GetAllRackHandler is the API Handler for getting all Racks
func NewGetAllRackHandler ¶
func NewGetAllRackHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllRackHandler
NewGetAllRackHandler initializes and returns a new handler for getting all Racks
func (GetAllRackHandler) Handle ¶
func (garh GetAllRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Racks @Description Get all Racks from Flow with optional filters @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of the Site" @Param includeComponents query boolean false "Include rack components in response" @Param name query string false "Filter by rack name" @Param manufacturer query string false "Filter by manufacturer" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} model.APIRack @Router /v2/org/{org}/nico/rack [get]
type GetAllRackHealthReportHandler ¶
type GetAllRackHealthReportHandler struct {
// contains filtered or unexported fields
}
GetAllRackHealthReportHandler lists Rack health reports.
func NewGetAllRackHealthReportHandler ¶
func NewGetAllRackHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) GetAllRackHealthReportHandler
NewGetAllRackHealthReportHandler returns a Rack health report list handler.
func (GetAllRackHealthReportHandler) Handle ¶
func (h GetAllRackHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Rack Health Reports @Description Get all health report overrides for a Rack. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Rack" @Param siteId query string true "ID of Site" Format(uuid) @Success 200 {array} model.APIMachineHealthReportEntry @Router /v2/org/{org}/nico/rack/{id}/health-report [get]
type GetAllSSHKeyGroupHandler ¶
type GetAllSSHKeyGroupHandler struct {
// contains filtered or unexported fields
}
GetAllSSHKeyGroupHandler is the API Handler for retrieving all SSH Key Groups
func NewGetAllSSHKeyGroupHandler ¶
func NewGetAllSSHKeyGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllSSHKeyGroupHandler
NewGetAllSSHKeyGroupHandler initializes and returns a new handler for retreiving all SSH Key Groups
func (GetAllSSHKeyGroupHandler) Handle ¶
func (gaskgh GetAllSSHKeyGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all SSH Key Groups @Description Get all SSH Key Group for the org @Tags SSHKeyGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param instanceId query string true "ID of Instance" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'Tenant'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} []model.APISSHKeyGroup @Router /v2/org/{org}/nico/sshkeygroup [get]
type GetAllSSHKeyHandler ¶
type GetAllSSHKeyHandler struct {
// contains filtered or unexported fields
}
GetAllSSHKeyHandler is the API Handler for retrieving all SSH Keys
func NewGetAllSSHKeyHandler ¶
func NewGetAllSSHKeyHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllSSHKeyHandler
NewGetAllSSHKeyHandler initializes and returns a new handler for retreiving all SSH Keys
func (GetAllSSHKeyHandler) Handle ¶
func (gaskh GetAllSSHKeyHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all SSH Keys @Description Get all SSH Keys for the org @Tags SSHKey @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param sshKeyGroupId query string true "ID of SSH Key Group" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'Tenant'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} []model.APISSHKey @Router /v2/org/{org}/nico/sshkey [get]
type GetAllSiteHandler ¶
type GetAllSiteHandler struct {
// contains filtered or unexported fields
}
GetAllSiteHandler is the API Handler for retrieving all Sites
func NewGetAllSiteHandler ¶
func NewGetAllSiteHandler(dbSession *cdb.Session, tc tClient.Client, cfg *config.Config) GetAllSiteHandler
NewGetAllSiteHandler initializes and returns a new handler for retrieving all Sites
func (GetAllSiteHandler) Handle ¶
func (gash GetAllSiteHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Sites @Description Get all Sites for the org @Tags site @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param isNativeNetworkingEnabled query boolean false "Filter by native networking enabled flag" @Param isNetworkSecurityGroupEnabled query boolean false "Filter by network security group enabled flag" @Param isNVLinkPartitionEnabled query boolean false "Filter by NVLink partition enabled flag" @Param isFlowEnabled query boolean false "Filter by NICo Flow enabled flag" @Param query query string false "Query input for full text search" @Param status query string false "Query input for status" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider'" @Success 200 {array} []model.APISite @Router /v2/org/{org}/nico/site [get]
type GetAllSkuHandler ¶
type GetAllSkuHandler struct {
// contains filtered or unexported fields
}
GetAllSkuHandler is the API Handler for getting all SKUs
func NewGetAllSkuHandler ¶
func NewGetAllSkuHandler(dbSession *cdb.Session, tc tclient.Client, cfg *config.Config) GetAllSkuHandler
NewGetAllSkuHandler initializes and returns a new handler for getting all SKUs
func (GetAllSkuHandler) Handle ¶
func (gash GetAllSkuHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all SKUs @Description Get all SKUs @Tags SKU @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site (optional, filters results to specific site)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APISku @Router /v2/org/{org}/nico/sku [get]
type GetAllSpectrumXPartitionHandler ¶
type GetAllSpectrumXPartitionHandler struct {
// contains filtered or unexported fields
}
GetAllSpectrumXPartitionHandler is the API Handler for retrieving all SpectrumXPartitions
func NewGetAllSpectrumXPartitionHandler ¶
func NewGetAllSpectrumXPartitionHandler(dbSession *cdb.Session, cfg *config.Config) GetAllSpectrumXPartitionHandler
NewGetAllSpectrumXPartitionHandler returns a handler for retrieving all SpectrumXPartitions
func (GetAllSpectrumXPartitionHandler) Handle ¶
func (gasxph GetAllSpectrumXPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all SpectrumXPartitions @Description Get all SpectrumXPartitions @Tags SpectrumXPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "ID of Site" @Param status query string false "Filter by status e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Tenant'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APISpectrumXPartition @Router /v2/org/{org}/nico/spectrumx-partition [get]
type GetAllSubnetHandler ¶
type GetAllSubnetHandler struct {
// contains filtered or unexported fields
}
GetAllSubnetHandler is the API Handler for getting all Subnets
func NewGetAllSubnetHandler ¶
func NewGetAllSubnetHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllSubnetHandler
NewGetAllSubnetHandler initializes and returns a new handler for getting all Subnets
func (GetAllSubnetHandler) Handle ¶
func (gash GetAllSubnetHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Subnets @Description Get all Subnets @Tags Subnet @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "Site ID" @Param vpcId query string true "ID of Vpc" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Vpc', 'Tenant', 'IPv4Block', 'IPv6Block'" @Param includeUsageStats query boolean false "Subnet IPv4 usage (interface/instance-derived; same shape as IP Block usage)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APISubnet @Router /v2/org/{org}/nico/subnet [get]
type GetAllTaskHandler ¶
type GetAllTaskHandler struct {
// contains filtered or unexported fields
}
GetAllTaskHandler is the API Handler for listing all Tasks in a Site.
func NewGetAllTaskHandler ¶
func NewGetAllTaskHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetAllTaskHandler
NewGetAllTaskHandler initializes a new GetAllTaskHandler.
func (GetAllTaskHandler) Handle ¶
func (h GetAllTaskHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Tasks @Description List all Tasks in the requested Site, with optional active-only and pagination filters. @Tags task @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "UUID of the Site" @Param activeOnly query boolean false "Restrict to non-terminal Tasks" @Param includeReport query boolean false "Include the per-task execution report in each response (default false)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Success 200 {array} model.APITask @Router /v2/org/{org}/nico/task [get]
type GetAllTaskRuleHandler ¶
type GetAllTaskRuleHandler struct {
// contains filtered or unexported fields
}
GetAllTaskRuleHandler is the API Handler for listing Operation Rules.
func NewGetAllTaskRuleHandler ¶
func NewGetAllTaskRuleHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllTaskRuleHandler
NewGetAllTaskRuleHandler initializes a new GetAllTaskRuleHandler.
func (GetAllTaskRuleHandler) Handle ¶
func (h GetAllTaskRuleHandler) Handle(c echo.Context) error
Handle godoc @Summary List Operation Rules @Description List Operation Rules on a Site, with optional operationType filter and pagination. @Tags rule @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of the Site" @Param operationType query string false "Filter by operation type (PowerControl|FirmwareControl)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Success 200 {array} model.APITaskRule @Router /v2/org/{org}/nico/task/rule [get]
type GetAllTaskRunHandler ¶
type GetAllTaskRunHandler struct {
// contains filtered or unexported fields
}
GetAllTaskRunHandler is the API Handler for listing Runs on a Site.
func NewGetAllTaskRunHandler ¶
func NewGetAllTaskRunHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllTaskRunHandler
NewGetAllTaskRunHandler initializes a new GetAllTaskRunHandler.
func (GetAllTaskRunHandler) Handle ¶
func (h GetAllTaskRunHandler) Handle(c echo.Context) error
Handle godoc @Summary List Runs @Description List Runs (operation runs) on a Site, newest first, with optional status and operationType filters and pagination. @Tags run @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of the Site" @Param status query string false "Filter by run status" @Param operationType query string false "Filter by operation type (PowerControl|FirmwareControl)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Success 200 {array} model.APITaskRun @Router /v2/org/{org}/nico/task/run [get]
type GetAllTaskRunTargetHandler ¶
type GetAllTaskRunTargetHandler struct {
// contains filtered or unexported fields
}
GetAllTaskRunTargetHandler is the API Handler for listing a Run's per-rack execution targets.
func NewGetAllTaskRunTargetHandler ¶
func NewGetAllTaskRunTargetHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllTaskRunTargetHandler
NewGetAllTaskRunTargetHandler initializes a new GetAllTaskRunTargetHandler.
func (GetAllTaskRunTargetHandler) Handle ¶
func (h GetAllTaskRunTargetHandler) Handle(c echo.Context) error
Handle godoc @Summary List Run targets @Description List a Run's materialized per-rack execution targets, with optional status and phaseScope filters and pagination. Each target references its Task via taskId. @Tags run @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Run" @Param siteId query string true "ID of the Site" @Param status query string false "Filter by target status" @Param phaseScope query string false "Phase scope (currentPhase|completedPhases|currentAndCompletedPhases; default currentPhase)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Success 200 {array} model.APITaskRunTarget @Router /v2/org/{org}/nico/task/run/{id}/target [get]
type GetAllTenantAccountHandler ¶
type GetAllTenantAccountHandler struct {
// contains filtered or unexported fields
}
GetAllTenantAccountHandler is the API Handler for getting all TenantAccounts
func NewGetAllTenantAccountHandler ¶
func NewGetAllTenantAccountHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllTenantAccountHandler
NewGetAllTenantAccountHandler initializes and returns a new handler for getting all TenantAccounts
func (GetAllTenantAccountHandler) Handle ¶
func (gatah GetAllTenantAccountHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all TenantAccounts @Description Get all TenantAccounts @Tags tenantaccount @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param infrastructureProviderId query string false "Deprecated: ID of Infrastructure Provider" @Param tenantId query string false "Filter TenantAccounts by Tenant ID (Provider role only; for Tenant role the tenant is inferred from org membership and this param is ignored)" @Param status query string false "Query input for status" @Param query query string false "Search query string" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APITenantAccount @Router /v2/org/{org}/nico/tenant/account [get]
type GetAllTrayHandler ¶
type GetAllTrayHandler struct {
// contains filtered or unexported fields
}
GetAllTrayHandler is the API Handler for getting all Trays
func NewGetAllTrayHandler ¶
func NewGetAllTrayHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetAllTrayHandler
NewGetAllTrayHandler initializes and returns a new handler for getting all Trays
func (GetAllTrayHandler) Handle ¶
func (gath GetAllTrayHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Trays @Description Get all Trays with optional filters @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of the Site" @Param rackId query string false "Filter by Rack ID" @Param rackName query string false "Filter by Rack name" @Param type query string false "Filter by tray type (Compute, NVSwitch, PowerShelf)" @Param id query string false "Filter by component ID (use repeated params for multiple values)" @Param slotId query int false "Filter by rack slot ID (position.slotId). Requires rackId or rackName. Composes with other filters via AND." @Param orderBy query string false "Order by field (e.g. name_ASC, manufacturer_DESC)" @Param pageNumber query int false "Page number (1-based)" @Param pageSize query int false "Page size" @Success 200 {array} model.APITray @Router /v2/org/{org}/nico/tray [get]
type GetAllTrayHealthReportHandler ¶
type GetAllTrayHealthReportHandler struct {
// contains filtered or unexported fields
}
GetAllTrayHealthReportHandler lists Tray health reports.
func NewGetAllTrayHealthReportHandler ¶
func NewGetAllTrayHealthReportHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) GetAllTrayHealthReportHandler
NewGetAllTrayHealthReportHandler returns a Tray health report list handler.
func (GetAllTrayHealthReportHandler) Handle ¶
func (h GetAllTrayHealthReportHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all Tray Health Reports @Description Get all health report overrides for a Tray component. @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Tray" @Param siteId query string true "ID of Site" Format(uuid) @Param type query string true "Tray type" Enums(Compute,NVSwitch,PowerShelf) @Success 200 {array} model.APIMachineHealthReportEntry @Router /v2/org/{org}/nico/tray/{id}/health-report [get]
type GetAllVPCHandler ¶
type GetAllVPCHandler struct {
// contains filtered or unexported fields
}
GetAllVPCHandler is the API Handler for retrieving all VPCs
func NewGetAllVPCHandler ¶
func NewGetAllVPCHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllVPCHandler
NewGetAllVPCHandler initializes and returns a new handler for retreiving all VPCs
func (GetAllVPCHandler) Handle ¶
func (gavh GetAllVPCHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all VPCs @Description Get all VPCs for the org @Tags vpc @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "Site ID" @Param nvLinkLogicalPartitionId query string false "NVLink Logical Partition ID" @Param status query string false "Filter by status" e.g. 'Pending', 'Error'" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Site', 'Tenant'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} []model.APIVpc @Router /v2/org/{org}/nico/vpc [get]
type GetAllVpcPeeringHandler ¶
type GetAllVpcPeeringHandler struct {
// contains filtered or unexported fields
}
GetAllVpcPeeringHandler is the API Handler for getting all VPC Peerings
func NewGetAllVpcPeeringHandler ¶
func NewGetAllVpcPeeringHandler(dbSession *cdb.Session, tc tclient.Client, cfg *config.Config) GetAllVpcPeeringHandler
NewGetAllVpcPeeringHandler initializes and returns a new handler for getting all VPC Peerings
func (GetAllVpcPeeringHandler) Handle ¶
func (gavph GetAllVpcPeeringHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all VPC Peerings @Description Get all VPC Peerings visible to the user. @Tags vpcpeering @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "Filter by Site ID" @Param isMultiTenant query bool false "Filter by single-tenant or multi-tenant peerings" @Param status query string false "Filter by status (repeatable for multiple values)" @Param vpcId query string false "Filter by VPC ID involved in the peering (as vpc1 or vpc2)" @Param peerTenantId query string false "Filter by tenant ID of a VPC involved in the peering (repeatable for multiple values)" @Param includeRelation query string false "Related entities to include in response e.g. 'Vpc1', 'Vpc2', 'Site'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {array} model.APIVpcPeering @Router /v2/org/{org}/nico/vpc-peering [get]
type GetAllVpcPrefixHandler ¶
type GetAllVpcPrefixHandler struct {
// contains filtered or unexported fields
}
GetAllVpcPrefixHandler is the API Handler for getting all VpcPrefixs
func NewGetAllVpcPrefixHandler ¶
func NewGetAllVpcPrefixHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllVpcPrefixHandler
NewGetAllVpcPrefixHandler initializes and returns a new handler for getting all VpcPrefixs
func (GetAllVpcPrefixHandler) Handle ¶
func (gash GetAllVpcPrefixHandler) Handle(c echo.Context) error
Handle godoc @Summary Get all VpcPrefixs @Description Get all VpcPrefixs @Tags vpcprefix @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string false "Site ID" @Param vpcId query string true "ID of Vpc" @Param query query string false "Query input for full text search" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Vpc', 'IPBlock'" @Param includeUsageStats query boolean false "IPv4 usage (interface/instance-derived; same shape as IP Block usage)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APIVpcPrefix @Router /v2/org/{org}/nico/vpcprefix [get]
type GetAllocationHandler ¶
type GetAllocationHandler struct {
// contains filtered or unexported fields
}
GetAllocationHandler is the API Handler for retrieving Allocation
func NewGetAllocationHandler ¶
func NewGetAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetAllocationHandler
NewGetAllocationHandler initializes and returns a new handler to retrieve Allocation
func (GetAllocationHandler) Handle ¶
func (gah GetAllocationHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the Allocation @Description Retrieve details of a specific Allocation by ID @Tags Allocation @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Allocation" @Param infrastructureProviderId query string false "Deprecated: ID of InfrastructureProvider" @Param tenantId query string false "Deprecated: ID of Tenant" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Success 200 {object} model.APIAllocation @Router /v2/org/{org}/nico/allocation/{id} [get]
type GetAuditEntryHandler ¶
type GetAuditEntryHandler struct {
// contains filtered or unexported fields
}
GetAuditEntryHandler is the API Handler for getting individual Audit Entry
func NewGetAuditEntryHandler ¶
func NewGetAuditEntryHandler(dbSession *cdb.Session) GetAuditEntryHandler
NewGetAuditEntryHandler initializes and returns a new handler for getting individual Audit Entry
func (GetAuditEntryHandler) Handle ¶
func (gaeh GetAuditEntryHandler) Handle(c echo.Context) error
Handle godoc @Summary Get an AuditEntry @Description Get an individual AuditEntry for the org @Tags site @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} model.APIAuditEntry @Router /v2/org/{org}/nico/audit/{id} [get]
type GetCredentialRotationStatusHandler ¶
type GetCredentialRotationStatusHandler struct {
// contains filtered or unexported fields
}
GetCredentialRotationStatusHandler reports convergence of a site-wide rotation.
func NewGetCredentialRotationStatusHandler ¶
func NewGetCredentialRotationStatusHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetCredentialRotationStatusHandler
NewGetCredentialRotationStatusHandler returns a handler that reports rotation convergence.
func (GetCredentialRotationStatusHandler) Handle ¶
func (h GetCredentialRotationStatusHandler) Handle(c echo.Context) error
Handle godoc @Summary Get Credential Rotation Status @Description Report convergence of an in-flight or completed site-wide credential rotation. When deviceMac is set, the counts describe just that device and a per-device detail block is returned. Equivalent to `nico-admin-cli credential rotation-status`. @Tags credential-rotation @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of the Site to query" @Param credentialType query string true "Credential family (BMC, HostUEFI, DPUUEFI, NVOS, LockdownIKM)" @Param deviceMac query string false "Report only this device's convergence, matched by MAC" @Success 200 {object} model.APICredentialRotationStatus @Router /v2/org/{org}/nico/credential/rotation [get]
type GetCurrentInfrastructureProviderHandler ¶
type GetCurrentInfrastructureProviderHandler struct {
// contains filtered or unexported fields
}
GetCurrentInfrastructureProviderHandler is the API Handler for retrieving Infrastructure Provider associated with the org
func NewGetCurrentInfrastructureProviderHandler ¶
func NewGetCurrentInfrastructureProviderHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetCurrentInfrastructureProviderHandler
NewGetCurrentInfrastructureProviderHandler initializes and returns a new handler to retrieve Infrastructure Provider associate with the org
func (GetCurrentInfrastructureProviderHandler) Handle ¶
func (gciph GetCurrentInfrastructureProviderHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the Infrastructure Provider associated with the org @Description Retrieve the Infrastructure Provider associated with the org. If it does not exist, it will be created. @Tags infrastructureprovider @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} model.APIInfrastructureProvider @Router /v2/org/{org}/nico/infrastructure-provider/current [get]
type GetCurrentInfrastructureProviderStatsHandler ¶
type GetCurrentInfrastructureProviderStatsHandler struct {
// contains filtered or unexported fields
}
GetCurrentInfrastructureProviderStatsHandler is the API Handler for retrieving InfrastructureProvider stats associated with the org
func NewGetCurrentInfrastructureProviderStatsHandler ¶
func NewGetCurrentInfrastructureProviderStatsHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetCurrentInfrastructureProviderStatsHandler
NewGetCurrentInfrastructureProviderStatsHandler initializes and returns a new handler to retrieve InfrastructureProvider stats associate with the org
func (GetCurrentInfrastructureProviderStatsHandler) Handle ¶
func (gcipsh GetCurrentInfrastructureProviderStatsHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the Infrastructure Provider stats associated with the org @Description Retrieve the Infrastructure Provider stats associated with the org @Tags infrastructureprovider @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} model.APIInfrastructureProviderStats @Router /v2/org/{org}/nico/infrastructure-provider/current/stats [get]
type GetCurrentServiceAccountHandler ¶
type GetCurrentServiceAccountHandler struct {
// contains filtered or unexported fields
}
GetCurrentServiceAccountHandler is the API Handler for getting the current Service Account
func NewGetCurrentServiceAccountHandler ¶
func NewGetCurrentServiceAccountHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetCurrentServiceAccountHandler
NewGetCurrentServiceAccountHandler initializes and returns a new handler for getting the current Service Account
func (GetCurrentServiceAccountHandler) Handle ¶
func (gcsah GetCurrentServiceAccountHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve information about the current Service Account @Description Retrieve information about the current Service Account. If it does not exist, it will be created. @Tags serviceaccount @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of organization" @Success 200 {object} model.APIServiceAccount @Router /v2/org/{org}/nico/service-account/current [get]
type GetCurrentTenantHandler ¶
type GetCurrentTenantHandler struct {
// contains filtered or unexported fields
}
GetCurrentTenantHandler is the API Handler for retrieving Tenant associated with the org
func NewGetCurrentTenantHandler ¶
func NewGetCurrentTenantHandler(dbSession *cdb.Session, scp *sc.ClientPool, tc temporalClient.Client, cfg *config.Config) GetCurrentTenantHandler
NewGetCurrentTenantHandler initializes and returns a new handler to retrieve Tenant associate with the org
func (GetCurrentTenantHandler) Handle ¶
func (gcth GetCurrentTenantHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the Tenant associated with the org @Description Retrieve the Tenant associated with the org. If it does not exist, it will be created. @Tags tenant @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} model.APITenant @Router /v2/org/{org}/nico/tenant/current [get]
type GetCurrentTenantRoutingProfileHandler ¶
type GetCurrentTenantRoutingProfileHandler struct {
// contains filtered or unexported fields
}
GetCurrentTenantRoutingProfileHandler retrieves the routing profiles the current Tenant may use at one Site.
func NewGetCurrentTenantRoutingProfileHandler ¶
func NewGetCurrentTenantRoutingProfileHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetCurrentTenantRoutingProfileHandler
NewGetCurrentTenantRoutingProfileHandler initializes the routing-profile handler.
func (GetCurrentTenantRoutingProfileHandler) Handle ¶
func (gctrph GetCurrentTenantRoutingProfileHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve current Tenant routing profiles for a Site @Description Retrieve the Tenant's default VPC routing profile and the profiles it may select at one Site. @Tags tenant @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of Site" @Success 200 {object} model.APITenantRoutingProfile @Router /v2/org/{org}/nico/tenant/current/routing-profile [get]
type GetCurrentTenantStatsHandler ¶
type GetCurrentTenantStatsHandler struct {
// contains filtered or unexported fields
}
GetCurrentTenantStatsHandler is the API Handler for retrieving Tenant stats associated with the org
func NewGetCurrentTenantStatsHandler ¶
func NewGetCurrentTenantStatsHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetCurrentTenantStatsHandler
NewGetCurrentTenantStatsHandler initializes and returns a new handler to retrieve Tenant stats associate with the org
func (GetCurrentTenantStatsHandler) Handle ¶
func (gcth GetCurrentTenantStatsHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the Tenant stats associated with the org @Description Retrieve the Tenant stats associated with the org @Tags tenant @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} model.APITenantStats @Router /v2/org/{org}/nico/tenant/current/stats [get]
type GetDpuExtensionServiceHandler ¶
type GetDpuExtensionServiceHandler struct {
// contains filtered or unexported fields
}
GetDpuExtensionServiceHandler is the API Handler for retrieving a DPU Extension Service
func NewGetDpuExtensionServiceHandler ¶
func NewGetDpuExtensionServiceHandler(dbSession *cdb.Session, tc tclient.Client, cfg *config.Config) GetDpuExtensionServiceHandler
NewGetDpuExtensionServiceHandler initializes and returns a new handler to retrieve DPU Extension Service
func (GetDpuExtensionServiceHandler) Handle ¶
func (gdesh GetDpuExtensionServiceHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve a DPU Extension Service @Description Retrieve a DPU Extension Service by ID for the current Tenant @Tags DPU Extension Service @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param dpuExtensionServiceId path string true "ID of DPU Extension Service" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Tenant'" @Success 200 {object} model.APIDpuExtensionService @Router /v2/org/{org}/nico/dpu-extension-service/{dpuExtensionServiceId} [get]
type GetDpuExtensionServiceVersionHandler ¶
type GetDpuExtensionServiceVersionHandler struct {
// contains filtered or unexported fields
}
GetDpuExtensionServiceVersionHandler is the API Handler for retrieving a DPU Extension Service version
func NewGetDpuExtensionServiceVersionHandler ¶
func NewGetDpuExtensionServiceVersionHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) GetDpuExtensionServiceVersionHandler
NewGetDpuExtensionServiceVersionHandler initializes and returns a new handler for retrieving DPU Extension Service version
func (GetDpuExtensionServiceVersionHandler) Handle ¶
func (gdesvh GetDpuExtensionServiceVersionHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve a DPU Extension Service version @Description Retrieve a specific version of a DPU Extension Service for the current Tenant @Tags DPU Extension Service @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param dpuExtensionServiceId path string true "ID of DPU Extension Service" @Param versionId path string true "Version ID" @Success 200 {object} model.APIDpuExtensionServiceVersionInfo @Router /v2/org/{org}/nico/dpu-extension-service/{dpuExtensionServiceId}/version/{versionId} [get]
type GetDpuMachineHandler ¶
type GetDpuMachineHandler struct {
// contains filtered or unexported fields
}
GetDpuMachineHandler retrieves one DPU Machine for a Site via Core.
func NewGetDpuMachineHandler ¶
func NewGetDpuMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetDpuMachineHandler
NewGetDpuMachineHandler returns a handler for retrieving one DPU Machine.
func (GetDpuMachineHandler) Handle ¶
func (gdmh GetDpuMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve a DPU Machine for a Site @Description Retrieve one DPU Machine for a Site. Network configuration is null unless includeNetworkConfig is true. @Tags Machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param dpuMachineId path string true "ID of DPU Machine" @Param siteId query string true "ID of Site" @Param includeNetworkConfig query boolean false "Include DPU network configuration" default(false) @Success 200 {object} model.APIDpuMachine @Router /v2/org/{org}/nico/dpu/{dpuMachineId} [get]
type GetExpectedMachineHandler ¶
type GetExpectedMachineHandler struct {
// contains filtered or unexported fields
}
GetExpectedMachineHandler is the API Handler for retrieving ExpectedMachine
func NewGetExpectedMachineHandler ¶
func NewGetExpectedMachineHandler(dbSession *cdb.Session, cfg *config.Config) GetExpectedMachineHandler
NewGetExpectedMachineHandler initializes and returns a new handler to retrieve ExpectedMachine
func (GetExpectedMachineHandler) Handle ¶
func (gemh GetExpectedMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the ExpectedMachine @Description Retrieve the ExpectedMachine by ID @Tags ExpectedMachine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Machine" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'SKU'" @Success 200 {object} model.APIExpectedMachine @Router /v2/org/{org}/nico/expected-machine/{id} [get]
type GetExpectedPowerShelfHandler ¶
type GetExpectedPowerShelfHandler struct {
// contains filtered or unexported fields
}
GetExpectedPowerShelfHandler is the API Handler for retrieving ExpectedPowerShelf
func NewGetExpectedPowerShelfHandler ¶
func NewGetExpectedPowerShelfHandler(dbSession *cdb.Session, cfg *config.Config) GetExpectedPowerShelfHandler
NewGetExpectedPowerShelfHandler initializes and returns a new handler to retrieve ExpectedPowerShelf
func (GetExpectedPowerShelfHandler) Handle ¶
func (gepsh GetExpectedPowerShelfHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the ExpectedPowerShelf @Description Retrieve the ExpectedPowerShelf by ID @Tags ExpectedPowerShelf @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Power Shelf" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Success 200 {object} model.APIExpectedPowerShelf @Router /v2/org/{org}/nico/expected-power-shelf/{id} [get]
type GetExpectedRackGroupHandler ¶
type GetExpectedRackGroupHandler struct {
// contains filtered or unexported fields
}
GetExpectedRackGroupHandler is the API Handler for retrieving an ExpectedRackGroup
func NewGetExpectedRackGroupHandler ¶
func NewGetExpectedRackGroupHandler(dbSession *cdb.Session, cfg *config.Config) GetExpectedRackGroupHandler
NewGetExpectedRackGroupHandler initializes and returns a new handler to retrieve ExpectedRackGroup
func (GetExpectedRackGroupHandler) Handle ¶
func (gerh GetExpectedRackGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the ExpectedRackGroup @Description Retrieve the ExpectedRackGroup by ID @Tags ExpectedRackGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Rack Group" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Success 200 {object} model.APIExpectedRackGroup @Router /v2/org/{org}/nico/expected-rack-group/{id} [get]
type GetExpectedRackHandler ¶
type GetExpectedRackHandler struct {
// contains filtered or unexported fields
}
GetExpectedRackHandler is the API Handler for retrieving an ExpectedRack
func NewGetExpectedRackHandler ¶
func NewGetExpectedRackHandler(dbSession *cdb.Session, cfg *config.Config) GetExpectedRackHandler
NewGetExpectedRackHandler initializes and returns a new handler to retrieve ExpectedRack
func (GetExpectedRackHandler) Handle ¶
func (gerh GetExpectedRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the ExpectedRack @Description Retrieve the ExpectedRack by ID @Tags ExpectedRack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Rack" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Success 200 {object} model.APIExpectedRack @Router /v2/org/{org}/expected-rack/{id} [get]
type GetExpectedSwitchHandler ¶
type GetExpectedSwitchHandler struct {
// contains filtered or unexported fields
}
GetExpectedSwitchHandler is the API Handler for retrieving ExpectedSwitch
func NewGetExpectedSwitchHandler ¶
func NewGetExpectedSwitchHandler(dbSession *cdb.Session, cfg *config.Config) GetExpectedSwitchHandler
NewGetExpectedSwitchHandler initializes and returns a new handler to retrieve ExpectedSwitch
func (GetExpectedSwitchHandler) Handle ¶
func (gesh GetExpectedSwitchHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the ExpectedSwitch @Description Retrieve the ExpectedSwitch by ID @Tags ExpectedSwitch @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Switch" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Success 200 {object} model.APIExpectedSwitch @Router /v2/org/{org}/nico/expected-switch/{id} [get]
type GetFabricHandler ¶
type GetFabricHandler struct {
// contains filtered or unexported fields
}
GetFabricHandler is the API Handler for retrieving Fabric
func NewGetFabricHandler ¶
func NewGetFabricHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetFabricHandler
NewGetFabricHandler initializes and returns a new handler to retrieve Fabric
func (GetFabricHandler) Handle ¶
func (gfh GetFabricHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve Fabric @Description Retrieve Fabric by ID. Endpoint is currently not exposed to users @Tags Fabric @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Fabric" @Param siteId query string true "ID of Site" @Param includeRelation query string false "Related entities to include in response e.g. 'Site'" @Success 200 {object} model.APIFabric @Router /v2/org/{org}/nico/site/{siteId}/fabric/{id} [get]
type GetIPBlockHandler ¶
type GetIPBlockHandler struct {
// contains filtered or unexported fields
}
GetIPBlockHandler is the API Handler for retrieving IPBlock
func NewGetIPBlockHandler ¶
func NewGetIPBlockHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetIPBlockHandler
NewGetIPBlockHandler initializes and returns a new handler to retrieve IPBlock
func (GetIPBlockHandler) Handle ¶
func (gipbh GetIPBlockHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the IPBlock @Description Retrieve the IPBlock @Tags IPBlock @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of IPBlock" @Param infrastructureProviderId query string false "Deprecated: Infrastructure Provider is now inferred from the org's membership" @Param tenantId query string false "Deprecated: Tenant is now inferred from the org's membership" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Param includeUsageStats query boolean false "IPBlock usage stats to include in response @Success 200 {object} model.APIIPBlock @Router /v2/org/{org}/nico/ipblock/{id} [get]
type GetInfiniBandPartitionHandler ¶
type GetInfiniBandPartitionHandler struct {
// contains filtered or unexported fields
}
GetInfiniBandPartitionHandler is the API Handler for retrieving InfiniBandPartition
func NewGetInfiniBandPartitionHandler ¶
func NewGetInfiniBandPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetInfiniBandPartitionHandler
NewGetInfiniBandPartitionHandler initializes and returns a new handler to retrieve InfiniBandPartition
func (GetInfiniBandPartitionHandler) Handle ¶
func (gibph GetInfiniBandPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the InfiniBandPartition @Description Retrieve the InfiniBandPartition @Tags InfiniBandPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of InfiniBandPartition" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Tenant'" @Success 200 {object} model.APIInfiniBandPartition @Router /v2/org/{org}/nico/infiniband-partition/{id} [get]
type GetInstanceHandler ¶
type GetInstanceHandler struct {
// contains filtered or unexported fields
}
GetInstanceHandler is the API Handler for getting an Instance
func NewGetInstanceHandler ¶
func NewGetInstanceHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetInstanceHandler
NewGetInstanceHandler initializes and returns a new handler for getting Instance
func (GetInstanceHandler) Handle ¶
func (gih GetInstanceHandler) Handle(c echo.Context) error
Handle godoc @Summary Get an Instance @Description Get an Instance for the org @Tags Instance @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Instance" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Success 200 {object} model.APIInstance @Router /v2/org/{org}/nico/instance/{id} [get]
type GetInstanceStatusDetailsHandler ¶
type GetInstanceStatusDetailsHandler struct {
// contains filtered or unexported fields
}
GetInstanceStatusDetailsHandler is the API Handler for getting Instance StatusDetail records
func NewGetInstanceStatusDetailsHandler ¶
func NewGetInstanceStatusDetailsHandler(dbSession *cdb.Session) GetInstanceStatusDetailsHandler
NewGetInstanceStatusDetailsHandler initializes and returns a new handler to retrieve Instance StatusDetail records
func (GetInstanceStatusDetailsHandler) Handle ¶
func (gisdh GetInstanceStatusDetailsHandler) Handle(c echo.Context) error
Handle godoc @Summary Get Instance StatusDetails @Description Get all StatusDetails for Instance @Tags instance @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Instance" @Success 200 {object} []model.APIStatusDetail @Router /v2/org/{org}/nico/instance/{id}/status-history [get]
type GetInstanceTypeHandler ¶
type GetInstanceTypeHandler struct {
// contains filtered or unexported fields
}
GetInstanceTypeHandler is the API Handler for getting details of a specific instance type
func NewGetInstanceTypeHandler ¶
func NewGetInstanceTypeHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetInstanceTypeHandler
NewGetInstanceTypeHandler initializes and returns a new handler for getting an Instance Type
func (GetInstanceTypeHandler) Handle ¶
func (gith GetInstanceTypeHandler) Handle(c echo.Context) error
Handle godoc @Summary Get details of an Instance Type @Description Retrieve details of a specific Instance Type by ID @Tags instancetype @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id query string true "ID of Instance Type" @Param includeAllocationStats query boolean false "Allocation stats to include in response" @Param includeMachineAssignment query boolean false "Machine associations entity to include in response (Provider only)" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Site'" @Success 200 {object} []model.APIInstanceType @Router /v2/org/{org}/nico/instance/type/{id} [get]
type GetIpxeTemplateHandler ¶
type GetIpxeTemplateHandler struct {
// contains filtered or unexported fields
}
GetIpxeTemplateHandler is the API Handler for retrieving a single iPXE template
func NewGetIpxeTemplateHandler ¶
func NewGetIpxeTemplateHandler(dbSession *cdb.Session, tc tclient.Client, cfg *config.Config) GetIpxeTemplateHandler
NewGetIpxeTemplateHandler initializes and returns a new handler to retrieve an iPXE template
func (GetIpxeTemplateHandler) Handle ¶
func (h GetIpxeTemplateHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve an iPXE template @Description Retrieve an iPXE template by its stable core ID. The caller must be authorized for at least one Site at which the template is currently available (Provider Admin/Viewer for a Site owned by their infrastructure provider, or Tenant Admin with a Tenant Account on a Site reporting the template). @Tags iPXE Template @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "Stable template ID (UUID from core)" @Success 200 {object} model.APIIpxeTemplate @Router /v2/org/{org}/nico/ipxe-template/{id} [get]
type GetJWKSHandler ¶
type GetJWKSHandler struct {
// contains filtered or unexported fields
}
GetJWKSHandler handles GET /.well-known/jwks.json and the SPIFFE variant.
func NewGetJWKSHandler ¶
func NewGetJWKSHandler(dbSession *cdb.Session, scp *sc.ClientPool, kind corev1.JwksKind) GetJWKSHandler
NewGetJWKSHandler returns a new GetJWKSHandler.
func (GetJWKSHandler) Handle ¶
func (gjwksh GetJWKSHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve JWKS @Description Public JSON Web Key Set for JWT-SVID signature verification. No authentication required. Returns 404 when no identity configuration exists for this org/site. @Tags TenantIdentity @Produce json @Param org path string true "Name of NGC organization" @Param siteID path string true "ID of Site" @Success 200 {string} string "JWKS JSON document" @Router /v2/org/{org}/nico/site/{siteID}/.well-known/jwks.json [get]
type GetMachineGPUStatsHandler ¶
type GetMachineGPUStatsHandler struct {
// contains filtered or unexported fields
}
GetMachineGPUStatsHandler is the API Handler for retrieving GPU stats for machines at a site
func NewGetMachineGPUStatsHandler ¶
func NewGetMachineGPUStatsHandler(dbSession *cdb.Session, cfg *config.Config) GetMachineGPUStatsHandler
NewGetMachineGPUStatsHandler initializes and returns a new handler for machine GPU stats
func (GetMachineGPUStatsHandler) Handle ¶
func (gmgsh GetMachineGPUStatsHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve GPU stats for machines at a site @Description Returns GPU summary stats grouped by GPU name for machines at the specified site @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param orgName path string true "Name of NGC organization" @Param siteId query string true "Site ID" @Success 200 {array} model.APIMachineGPUStats @Router /v2/org/{orgName}/nico/machine/gpu/stats [get]
type GetMachineHandler ¶
type GetMachineHandler struct {
// contains filtered or unexported fields
}
GetMachineHandler is the API Handler for retrieving Machine
func NewGetMachineHandler ¶
func NewGetMachineHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetMachineHandler
NewGetMachineHandler initializes and returns a new handler to retrieve Machine
func (GetMachineHandler) Handle ¶
func (gmh GetMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the Machine @Description Retrieve the Machine @Tags Machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Param includeMetadata query boolean false "Include metadata info in response" @Success 200 {object} model.APIMachine @Router /v2/org/{org}/nico/machine/{id} [get]
type GetMachineInstanceTypeStatsHandler ¶
type GetMachineInstanceTypeStatsHandler struct {
// contains filtered or unexported fields
}
GetMachineInstanceTypeStatsHandler is the API Handler for retrieving detailed per-instance-type machine stats
func NewGetMachineInstanceTypeStatsHandler ¶
func NewGetMachineInstanceTypeStatsHandler(dbSession *cdb.Session, cfg *config.Config) GetMachineInstanceTypeStatsHandler
NewGetMachineInstanceTypeStatsHandler initializes and returns a new handler for machine instance type stats
func (GetMachineInstanceTypeStatsHandler) Handle ¶
func (gmitsh GetMachineInstanceTypeStatsHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve detailed per-instance-type machine stats for a site @Description Returns machine stats for each instance type including allocation details and tenant breakdown @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param orgName path string true "Name of NGC organization" @Param siteId query string true "Site ID" @Success 200 {array} model.APIMachineInstanceTypeStats @Router /v2/org/{orgName}/nico/machine/instance-type/stats [get]
type GetMachineInstanceTypeSummaryHandler ¶
type GetMachineInstanceTypeSummaryHandler struct {
// contains filtered or unexported fields
}
GetMachineInstanceTypeSummaryHandler is the API Handler for retrieving assigned vs unassigned machine summary
func NewGetMachineInstanceTypeSummaryHandler ¶
func NewGetMachineInstanceTypeSummaryHandler(dbSession *cdb.Session, cfg *config.Config) GetMachineInstanceTypeSummaryHandler
NewGetMachineInstanceTypeSummaryHandler initializes and returns a new handler for machine instance type summary
func (GetMachineInstanceTypeSummaryHandler) Handle ¶
func (gmitsh GetMachineInstanceTypeSummaryHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve machine instance type assignment summary for a site @Description Returns machine counts grouped by assigned (has instance type) vs unassigned, broken down by status @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param orgName path string true "Name of NGC organization" @Param siteId query string true "Site ID" @Success 200 {object} model.APIMachineInstanceTypeSummary @Router /v2/org/{orgName}/nico/machine/instance-type/stats/summary [get]
type GetMachineSpectrumXMultiplaneHandler ¶
type GetMachineSpectrumXMultiplaneHandler struct {
// contains filtered or unexported fields
}
GetMachineSpectrumXMultiplaneHandler retrieves configuration and independent DPU observations.
func NewGetMachineSpectrumXMultiplaneHandler ¶
func NewGetMachineSpectrumXMultiplaneHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetMachineSpectrumXMultiplaneHandler
NewGetMachineSpectrumXMultiplaneHandler returns the machine multiplane read handler.
func (GetMachineSpectrumXMultiplaneHandler) Handle ¶
func (h GetMachineSpectrumXMultiplaneHandler) Handle(c echo.Context) error
Handle godoc @Summary Get Machine Spectrum-X Multiplane @Description Retrieve desired rail/plane maintenance configuration and separate observations for each BlueField-4 DPU. For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with `PROVIDER_ADMIN` or `PROVIDER_VIEWER` suffix. @Tags machine @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param machineId path string true "ID of Machine" @Success 200 {object} model.APIMachineSpectrumXMultiplane @Router /v2/org/{org}/nico/machine/{machineId}/spectrumx-multiplane [get]
type GetMachineStatusDetailsHandler ¶
type GetMachineStatusDetailsHandler struct {
// contains filtered or unexported fields
}
GetMachineStatusDetailsHandler is the API Handler for getting Machine StatusDetail records
func NewGetMachineStatusDetailsHandler ¶
func NewGetMachineStatusDetailsHandler(dbSession *cdb.Session) GetMachineStatusDetailsHandler
NewGetMachineStatusDetailsHandler initializes and returns a new handler to retrieve Machine StatusDetail records
func (GetMachineStatusDetailsHandler) Handle ¶
func (gmsdh GetMachineStatusDetailsHandler) Handle(c echo.Context) error
Handle godoc @Summary Get Machine StatusDetails @Description Get all StatusDetails for Machine @Tags Machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Success 200 {object} []model.APIStatusDetail @Router /v2/org/{org}/nico/machine/{id}/status-history [get]
type GetMachineValidationExternalConfigHandler ¶
type GetMachineValidationExternalConfigHandler struct {
// contains filtered or unexported fields
}
GetMachineValidationExternalConfigHandler is the API Handler to get MachineValidationExternalConfig
func NewGetMachineValidationExternalConfigHandler ¶
func NewGetMachineValidationExternalConfigHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) GetMachineValidationExternalConfigHandler
NewGetMachineValidationExternalConfigHandler initializes and returns a new handler to get MachineValidationTest
func (GetMachineValidationExternalConfigHandler) Handle ¶
func (handler GetMachineValidationExternalConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Get MachineValidationExternalConfig @Description Get MachineValidationExternalConfig @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} model.APIMachineValidationExternalConfig @Router /v2/org/{org}/nico/site/{site}/machine-validation/external-config/{name} [get]
type GetMachineValidationResultsHandler ¶
type GetMachineValidationResultsHandler struct {
// contains filtered or unexported fields
}
GetMachineValidationResultsHandler is the API Handler to get MachineValidationResults
func NewGetMachineValidationResultsHandler ¶
func NewGetMachineValidationResultsHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) GetMachineValidationResultsHandler
NewGetMachineValidationResultsHandler initializes and returns a new handler to get MachineValidationResults
func (GetMachineValidationResultsHandler) Handle ¶
func (handler GetMachineValidationResultsHandler) Handle(c echo.Context) error
Handle godoc @Summary Get Machine validation results @Description Get Machine validation results @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param machineId path string true "ID of Machine" @Success 200 {object} []model.APIMachineValidationResult @Router /v2/org/{org}/nico/machine/{machineId}/validation/result [get]
type GetMachineValidationTestHandler ¶
type GetMachineValidationTestHandler struct {
// contains filtered or unexported fields
}
GetMachineValidationTestHandler is the API Handler to get MachineValidationTest
func NewGetMachineValidationTestHandler ¶
func NewGetMachineValidationTestHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) GetMachineValidationTestHandler
NewGetMachineValidationTestHandler initializes and returns a new handler to get MachineValidationTest
func (GetMachineValidationTestHandler) Handle ¶
func (handler GetMachineValidationTestHandler) Handle(c echo.Context) error
Handle godoc @Summary Get MachineValidationTest @Description Get MachineValidationTest @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} model.APIMachineValidationTest @Router /v2/org/{org}/nico/site/{site}/machine-validation/test [get]
type GetNVLinkDomainHandler ¶
type GetNVLinkDomainHandler struct {
// contains filtered or unexported fields
}
GetNVLinkDomainHandler is the API Handler for getting an NVLink Domain by ID
func NewGetNVLinkDomainHandler ¶
func NewGetNVLinkDomainHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetNVLinkDomainHandler
NewGetNVLinkDomainHandler initializes and returns a new handler for getting an NVLink Domain
func (GetNVLinkDomainHandler) Handle ¶
func (gndh GetNVLinkDomainHandler) Handle(c echo.Context) error
Handle godoc @Summary Get an NVLink Domain @Description Get an NVLink Domain by ID @Tags Domain @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of NVLink Domain" @Param siteId query string true "ID of the Site" @Param includeComponents query boolean false "Include domain components in response" @Success 200 {object} model.APINVLinkDomain @Router /v2/org/{org}/nico/domain/nvlink/{id} [get]
type GetNVLinkLogicalPartitionHandler ¶
type GetNVLinkLogicalPartitionHandler struct {
// contains filtered or unexported fields
}
GetNVLinkLogicalPartitionHandler is the API Handler for retrieving NVLinkLogicalPartition
func NewGetNVLinkLogicalPartitionHandler ¶
func NewGetNVLinkLogicalPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetNVLinkLogicalPartitionHandler
NewGetNVLinkLogicalPartitionHandler initializes and returns a new handler to retrieve NVLinkLogicalPartition
func (GetNVLinkLogicalPartitionHandler) Handle ¶
func (gibph GetNVLinkLogicalPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the NVLinkLogicalPartition @Description Retrieve the NVLinkLogicalPartition @Tags NVLinkLogicalPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of NVLinkLogicalPartition" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Tenant'" @Param includeInterfaces query boolean false "Include NVLinkInterfaces in response" @Param includeStats query boolean false "Include NVLinkLogicalPartitionStats in response" @Success 200 {object} model.APINVLinkLogicalPartition @Router /v2/org/{org}/nico/nvlink-logical-partition/{id} [get]
type GetNetworkSecurityGroupHandler ¶
type GetNetworkSecurityGroupHandler struct {
// contains filtered or unexported fields
}
GetAllNetworkSecurityGroupHandler is the API Handler for getting a NetworkSecurityGroup
func NewGetNetworkSecurityGroupHandler ¶
func NewGetNetworkSecurityGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetNetworkSecurityGroupHandler
NewGetAllNetworkSecurityGroupHandler initializes and returns a new handler for getting all NetworkSecurityGroups
func (GetNetworkSecurityGroupHandler) Handle ¶
func (gansgh GetNetworkSecurityGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Get a NetworkSecurityGroup @Description Get a NetworkSecurityGroup for a given Tenant @Tags networksecuritygroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param includeAttachmentStats query boolean false "Attachment stats to include in response" @Param includeRelation query string false "Related entities to include in response e.g. 'Tenant', 'Site'" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Param orderBy query string false "Order by field" @Success 200 {object} []model.APINetworkSecurityGroup @Router /v2/org/{org}/nico/network-security-group [get]
type GetOpenIDConfigurationHandler ¶
type GetOpenIDConfigurationHandler struct {
// contains filtered or unexported fields
}
GetOpenIDConfigurationHandler handles GET /.well-known/openid-configuration.
func NewGetOpenIDConfigurationHandler ¶
func NewGetOpenIDConfigurationHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetOpenIDConfigurationHandler
NewGetOpenIDConfigurationHandler returns a new GetOpenIDConfigurationHandler.
func (GetOpenIDConfigurationHandler) Handle ¶
func (goidch GetOpenIDConfigurationHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve OpenID Configuration @Description Public OIDC discovery document pointing at this org's JWKS URIs. No authentication required. Returns 404 when no identity material exists for this org/site. @Tags TenantIdentity @Produce json @Param org path string true "Name of NGC organization" @Param siteID path string true "ID of Site" @Success 200 {object} model.APIOpenIDConfiguration @Router /v2/org/{org}/nico/site/{siteID}/.well-known/openid-configuration [get]
type GetOperatingSystemHandler ¶
type GetOperatingSystemHandler struct {
// contains filtered or unexported fields
}
GetOperatingSystemHandler is the API Handler for retrieving OperatingSystem
func NewGetOperatingSystemHandler ¶
func NewGetOperatingSystemHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetOperatingSystemHandler
NewGetOperatingSystemHandler initializes and returns a new handler to retrieve OperatingSystem
func (GetOperatingSystemHandler) Handle ¶
func (gsh GetOperatingSystemHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the OperatingSystem @Description Retrieve the OperatingSystem @Tags OperatingSystem @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of OperatingSystem" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant', 'Site'" @Success 200 {object} model.APIOperatingSystem @Router /v2/org/{org}/nico/operating-system/{id} [get]
type GetRackHandler ¶
type GetRackHandler struct {
// contains filtered or unexported fields
}
GetRackHandler is the API Handler for getting a Rack by ID
func NewGetRackHandler ¶
func NewGetRackHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetRackHandler
NewGetRackHandler initializes and returns a new handler for getting a Rack
func (GetRackHandler) Handle ¶
func (grh GetRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Get a Rack @Description Get a Rack by ID from Flow @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Rack" @Param siteId query string true "ID of the Site" @Param includeComponents query boolean false "Include rack components in response" @Success 200 {object} model.APIRack @Router /v2/org/{org}/nico/rack/{id} [get]
type GetRackPowerStateHandler ¶
type GetRackPowerStateHandler struct {
// contains filtered or unexported fields
}
GetRackPowerStateHandler returns rack power summaries, member details and outstanding work to Provider Admins.
func NewGetRackPowerStateHandler ¶
func NewGetRackPowerStateHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetRackPowerStateHandler
NewGetRackPowerStateHandler returns a handler that uses the shared site client pool for Flow requests.
func (GetRackPowerStateHandler) ForRack ¶
func (h GetRackPowerStateHandler) ForRack(id string) GetRackPowerStateHandler
ForRack binds an inventory ID for a literal route that would otherwise match the existing `/rack/task/:id` route. Ordinary rack reads use the path parameter.
func (GetRackPowerStateHandler) Handle ¶
func (h GetRackPowerStateHandler) Handle(c echo.Context) error
Handle returns independently available rack power sections without starting power work. @Summary Get Rack power state @Tags Rack @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "External inventory Rack ID" @Param siteId query string true "ID of the Site" @Success 200 {object} model.APIRackPowerState @Router /v2/org/{org}/nico/rack/{id}/power [get]
type GetRackTasksHandler ¶
type GetRackTasksHandler struct {
// contains filtered or unexported fields
}
GetRackTasksHandler is the API Handler for listing Tasks targeting a Rack.
func NewGetRackTasksHandler ¶
func NewGetRackTasksHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetRackTasksHandler
NewGetRackTasksHandler initializes a new GetRackTasksHandler.
func (GetRackTasksHandler) Handle ¶
func (h GetRackTasksHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Tasks for a Rack @Description List Tasks targeting the given Rack, with optional active-only and pagination filters. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "Rack ID" @Param siteId query string true "ID of the Site" @Param activeOnly query boolean false "Restrict to non-terminal Tasks" @Param includeReport query boolean false "Include the per-task execution report in each response (default false)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Success 200 {array} model.APITask @Router /v2/org/{org}/nico/rack/{id}/task [get]
type GetSSHKeyGroupHandler ¶
type GetSSHKeyGroupHandler struct {
// contains filtered or unexported fields
}
GetSSHKeyGroupHandler is the API Handler for getting an SSH Key Group
func NewGetSSHKeyGroupHandler ¶
func NewGetSSHKeyGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetSSHKeyGroupHandler
NewGetSSHKeyGroupHandler initializes and returns a new handler for getting SSH Key Group
func (GetSSHKeyGroupHandler) Handle ¶
func (gskgh GetSSHKeyGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Get an SSH Key Group @Description Get an SSH Key Group for the org @Tags SSHKeyGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of SSH Key Group" @Param includeRelation query string false "Related entities to include in response e.g. 'Tenant'" @Success 200 {object} model.APISSHKeyGroup @Router /v2/org/{org}/nico/sshkeygroup/{id} [get]
type GetSSHKeyHandler ¶
type GetSSHKeyHandler struct {
// contains filtered or unexported fields
}
GetSSHKeyHandler is the API Handler for getting an SSH Key
func NewGetSSHKeyHandler ¶
func NewGetSSHKeyHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetSSHKeyHandler
NewGetSSHKeyHandler initializes and returns a new handler for getting SSH Key
func (GetSSHKeyHandler) Handle ¶
func (gskh GetSSHKeyHandler) Handle(c echo.Context) error
Handle godoc @Summary Get an SSH Key @Description Get an SSH Key for the org @Tags SSHKey @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of SSH Key" @Param includeRelation query string false "Related entities to include in response e.g. 'Tenant'" @Success 200 {object} model.APISSHKey @Router /v2/org/{org}/nico/sshkey/{id} [get]
type GetSiteHandler ¶
type GetSiteHandler struct {
// contains filtered or unexported fields
}
GetSiteHandler is the API Handler for getting a Site
func NewGetSiteHandler ¶
func NewGetSiteHandler(dbSession *cdb.Session, tc tClient.Client, cfg *config.Config) GetSiteHandler
NewGetSiteHandler initializes and returns a new handler for getting Site
func (GetSiteHandler) Handle ¶
func (gsh GetSiteHandler) Handle(c echo.Context) error
Handle godoc @Summary Get a Site @Description Get a Site for the org @Tags site @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Site" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider'" @Success 200 {object} model.APISite @Router /v2/org/{org}/nico/site/{id} [get]
type GetSiteStatusDetailsHandler ¶
type GetSiteStatusDetailsHandler struct {
// contains filtered or unexported fields
}
GetSiteStatusDetailsHandler is the API Handler for getting Site StatusDetail records
func NewGetSiteStatusDetailsHandler ¶
func NewGetSiteStatusDetailsHandler(dbSession *cdb.Session) GetSiteStatusDetailsHandler
NewGetSiteStatusDetailsHandler initializes and returns a new handler to retrieve Site StatusDetail records
func (GetSiteStatusDetailsHandler) Handle ¶
func (gssdh GetSiteStatusDetailsHandler) Handle(c echo.Context) error
Handle godoc @Summary Get Site StatusDetails @Description Get all StatusDetails for Site @Tags Site @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Site" @Success 200 {object} []model.APIStatusDetail @Router /v2/org/{org}/nico/Site/{id}/status-history [get]
type GetSkuHandler ¶
type GetSkuHandler struct {
// contains filtered or unexported fields
}
GetSkuHandler is the API Handler for retrieving SKU
func NewGetSkuHandler ¶
NewGetSkuHandler initializes and returns a new handler to retrieve SKU
func (GetSkuHandler) Handle ¶
func (gsh GetSkuHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the SKU @Description Retrieve the SKU by ID @Tags SKU @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of SKU" @Success 200 {object} model.APISku @Router /v2/org/{org}/nico/sku/{id} [get]
type GetSpectrumXPartitionHandler ¶
type GetSpectrumXPartitionHandler struct {
// contains filtered or unexported fields
}
GetSpectrumXPartitionHandler is the API Handler for retrieving a SpectrumXPartition
func NewGetSpectrumXPartitionHandler ¶
func NewGetSpectrumXPartitionHandler(dbSession *cdb.Session, cfg *config.Config) GetSpectrumXPartitionHandler
NewGetSpectrumXPartitionHandler returns a handler for retrieving a SpectrumXPartition
func (GetSpectrumXPartitionHandler) Handle ¶
func (gsxph GetSpectrumXPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Get a SpectrumXPartition @Description Get a SpectrumXPartition @Tags SpectrumXPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param spectrumXPartitionId path string true "ID of SpectrumXPartition" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Tenant'" @Success 200 {object} model.APISpectrumXPartition @Router /v2/org/{org}/nico/spectrumx-partition/{spectrumXPartitionId} [get]
type GetSubnetHandler ¶
type GetSubnetHandler struct {
// contains filtered or unexported fields
}
GetSubnetHandler is the API Handler for retrieving Subnet
func NewGetSubnetHandler ¶
func NewGetSubnetHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetSubnetHandler
NewGetSubnetHandler initializes and returns a new handler to retrieve Subnet
func (GetSubnetHandler) Handle ¶
func (gsh GetSubnetHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the Subnet @Description Retrieve the Subnet @Tags Subnet @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Subnet" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Vpc', 'Tenant', 'IPv4Block', 'IPv6Block'" @Param includeUsageStats query boolean false "Subnet IPv4 usage (interface/instance-derived; same shape as IP Block usage)" @Success 200 {object} model.APISubnet @Router /v2/org/{org}/nico/subnet/{id} [get]
type GetTaskHandler ¶
type GetTaskHandler struct {
// contains filtered or unexported fields
}
GetTaskHandler is the API Handler for getting a Task by ID
func NewGetTaskHandler ¶
func NewGetTaskHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetTaskHandler
NewGetTaskHandler initializes and returns a new handler for getting a Task
func (GetTaskHandler) Handle ¶
func (gth GetTaskHandler) Handle(c echo.Context) error
Handle godoc @Summary Get a Task @Description Get a Task by UUID @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Task" @Param siteId query string true "ID of the Site" @Success 200 {object} model.APITask @Router /v2/org/{org}/nico/rack/task/{id} [get]
type GetTaskRuleHandler ¶
type GetTaskRuleHandler struct {
// contains filtered or unexported fields
}
GetTaskRuleHandler is the API Handler for getting an Operation Rule by ID.
func NewGetTaskRuleHandler ¶
func NewGetTaskRuleHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetTaskRuleHandler
NewGetTaskRuleHandler initializes and returns a new handler for getting a Rule.
func (GetTaskRuleHandler) Handle ¶
func (h GetTaskRuleHandler) Handle(c echo.Context) error
Handle godoc @Summary Get an Operation Rule @Description Get an Operation Rule by UUID @Tags rule @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Rule" @Param siteId query string true "ID of the Site" @Success 200 {object} model.APITaskRule @Router /v2/org/{org}/nico/task/rule/{id} [get]
type GetTaskRunHandler ¶
type GetTaskRunHandler struct {
// contains filtered or unexported fields
}
GetTaskRunHandler is the API Handler for getting a Run by ID.
func NewGetTaskRunHandler ¶
func NewGetTaskRunHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetTaskRunHandler
NewGetTaskRunHandler initializes a new GetTaskRunHandler.
func (GetTaskRunHandler) Handle ¶
func (h GetTaskRunHandler) Handle(c echo.Context) error
Handle godoc @Summary Get a Run @Description Get a Run by UUID. Set includeStats=true for derived per-phase outcome counts. @Tags run @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Run" @Param siteId query string true "ID of the Site" @Param includeStats query boolean false "Include derived per-phase outcome stats (default false)" @Success 200 {object} model.APITaskRun @Router /v2/org/{org}/nico/task/run/{id} [get]
type GetTenantAccountHandler ¶
type GetTenantAccountHandler struct {
// contains filtered or unexported fields
}
GetTenantAccountHandler is the API Handler for retrieving TenantAccount
func NewGetTenantAccountHandler ¶
func NewGetTenantAccountHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetTenantAccountHandler
NewGetTenantAccountHandler initializes and returns a new handler to retrieve TenantAccount
func (GetTenantAccountHandler) Handle ¶
func (gtah GetTenantAccountHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the TenantAccount @Description Retrieve the TenantAccount @Tags tenantaccount @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Tenant Account" @Param infrastructureProviderId query string false "Deprecated: ID of Infrastructure Provider" @Param tenantId query string false "Deprecated: ID of Tenant" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Tenant'" @Success 200 {object} model.APITenantAccount @Router /v2/org/{org}/nico/tenant/account/{id} [get]
type GetTenantIdentityConfigHandler ¶
type GetTenantIdentityConfigHandler struct {
// contains filtered or unexported fields
}
GetTenantIdentityConfigHandler handles GET /tenant-identity/config.
func NewGetTenantIdentityConfigHandler ¶
func NewGetTenantIdentityConfigHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetTenantIdentityConfigHandler
NewGetTenantIdentityConfigHandler returns a new GetTenantIdentityConfigHandler.
func (GetTenantIdentityConfigHandler) Handle ¶
func (gmich GetTenantIdentityConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve Tenant Identity Config for an org @Description Retrieve the current per-org tenant identity configuration and signing keys. @Tags TenantIdentity @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteID path string true "ID of Site" @Success 200 {object} model.APITenantIdentityConfig @Router /v2/org/{org}/nico/site/{siteID}/tenant-identity/config [get]
type GetTenantIdentityTokenDelegationHandler ¶
type GetTenantIdentityTokenDelegationHandler struct {
// contains filtered or unexported fields
}
GetTenantIdentityTokenDelegationHandler handles GET /tenant-identity/token-delegation.
func NewGetTenantIdentityTokenDelegationHandler ¶
func NewGetTenantIdentityTokenDelegationHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetTenantIdentityTokenDelegationHandler
NewGetTenantIdentityTokenDelegationHandler returns a new GetTenantIdentityTokenDelegationHandler.
func (GetTenantIdentityTokenDelegationHandler) Handle ¶
func (gtdh GetTenantIdentityTokenDelegationHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve Token Delegation for an org @Description Retrieve the currently registered token exchange endpoint. The raw secret is never returned; only its SHA-256 hash. @Tags TenantIdentity @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteID path string true "ID of Site" @Success 200 {object} model.APITenantIdentityTokenDelegation @Router /v2/org/{org}/nico/site/{siteID}/tenant-identity/token-delegation [get]
type GetTenantInstanceTypeStatsHandler ¶
type GetTenantInstanceTypeStatsHandler struct {
// contains filtered or unexported fields
}
GetTenantInstanceTypeStatsHandler is the API Handler for retrieving per-tenant instance type allocation stats
func NewGetTenantInstanceTypeStatsHandler ¶
func NewGetTenantInstanceTypeStatsHandler(dbSession *cdb.Session, cfg *config.Config) GetTenantInstanceTypeStatsHandler
NewGetTenantInstanceTypeStatsHandler initializes and returns a new handler for tenant instance type stats
func (GetTenantInstanceTypeStatsHandler) Handle ¶
func (gtitsh GetTenantInstanceTypeStatsHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve per-tenant instance type allocation stats for a site @Description Returns instance type allocation stats grouped by tenant for the specified site @Tags tenant @Accept json @Produce json @Security ApiKeyAuth @Param orgName path string true "Name of NGC organization" @Param siteId query string true "Site ID" @Success 200 {array} model.APITenantInstanceTypeStats @Router /v2/org/{orgName}/nico/tenant/instance-type/stats [get]
type GetTrayHandler ¶
type GetTrayHandler struct {
// contains filtered or unexported fields
}
GetTrayHandler is the API Handler for getting a Tray by ID
func NewGetTrayHandler ¶
func NewGetTrayHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetTrayHandler
NewGetTrayHandler initializes and returns a new handler for getting a Tray
func (GetTrayHandler) Handle ¶
func (gth GetTrayHandler) Handle(c echo.Context) error
Handle godoc @Summary Get a Tray @Description Get a Tray by ID @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Tray" @Param siteId query string true "ID of the Site" @Success 200 {object} model.APITray @Router /v2/org/{org}/nico/tray/{id} [get]
type GetTrayPowerStateHandler ¶
type GetTrayPowerStateHandler struct {
// contains filtered or unexported fields
}
GetTrayPowerStateHandler returns tray power state and operations to Provider Admins.
func NewGetTrayPowerStateHandler ¶
func NewGetTrayPowerStateHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetTrayPowerStateHandler
NewGetTrayPowerStateHandler uses the shared site client pool for Flow requests.
func (GetTrayPowerStateHandler) Handle ¶
func (h GetTrayPowerStateHandler) Handle(c echo.Context) error
Handle returns independently available tray power sections without starting power work. @Summary Get Tray power state @Tags tray @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "Component ID or component MAC address" @Param siteId query string true "ID of the Site" @Success 200 {object} model.APITrayPowerState @Router /v2/org/{org}/nico/tray/{id}/power [get]
type GetTrayTasksHandler ¶
type GetTrayTasksHandler struct {
// contains filtered or unexported fields
}
GetTrayTasksHandler is the API Handler for listing Tasks targeting a Tray.
func NewGetTrayTasksHandler ¶
func NewGetTrayTasksHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) GetTrayTasksHandler
NewGetTrayTasksHandler initializes a new GetTrayTasksHandler.
func (GetTrayTasksHandler) Handle ¶
func (h GetTrayTasksHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve all Tasks for a Tray @Description List Tasks targeting the given Tray by component ID, with optional active-only and pagination filters. @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "Component ID" @Param siteId query string true "ID of the Site" @Param activeOnly query boolean false "Restrict to non-terminal Tasks" @Param includeReport query boolean false "Include the per-task execution report in each response (default false)" @Param pageNumber query integer false "Page number of results returned" @Param pageSize query integer false "Number of results per page" @Success 200 {array} model.APITask @Router /v2/org/{org}/nico/tray/{id}/task [get]
type GetUserHandler ¶
type GetUserHandler struct {
// contains filtered or unexported fields
}
GetUserHandler is an API Handler to return information about the current user
func NewGetUserHandler ¶
func NewGetUserHandler(dbSession *cdb.Session) GetUserHandler
NewGetUserHandler creates and returns a new handler
func (GetUserHandler) Handle ¶
func (guh GetUserHandler) Handle(c echo.Context) error
Handle godoc @Summary Return information about the current user @Description Get basic information about the user making the request @Tags user @Accept */* @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Success 200 {object} model.APIUser @Router /v2/org/{org}/nico/user/current [get]
type GetVPCHandler ¶
type GetVPCHandler struct {
// contains filtered or unexported fields
}
GetVPCHandler is the API Handler for getting a VPC
func NewGetVPCHandler ¶
func NewGetVPCHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetVPCHandler
NewGetVPCHandler initializes and returns a new handler for getting VPC
func (GetVPCHandler) Handle ¶
func (gvh GetVPCHandler) Handle(c echo.Context) error
Handle godoc @Summary Get a VPC @Description Get a VPC for the org @Tags vpc @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Vpc" @Param includeRelation query string false "Related entities to include in response e.g. 'InfrastructureProvider', 'Site', 'Tenant'" @Success 200 {object} model.APIVpc @Router /v2/org/{org}/nico/vpc/{id} [get]
type GetVPCRoutingProfileHandler ¶
type GetVPCRoutingProfileHandler struct {
// contains filtered or unexported fields
}
GetVPCRoutingProfileHandler reads authoritative VPC routing and allocation state.
func NewGetVPCRoutingProfileHandler ¶
func NewGetVPCRoutingProfileHandler(dbSession *cdb.Session, scp *sc.ClientPool) GetVPCRoutingProfileHandler
NewGetVPCRoutingProfileHandler returns a provider-only routing inspection handler.
func (GetVPCRoutingProfileHandler) Handle ¶
func (h GetVPCRoutingProfileHandler) Handle(c echo.Context) error
Handle godoc @Summary Get VPC Routing Profile @Description Inspect persisted routing and allocations; this does not verify dataplane convergence. @Tags vpc @Produce json @Security ApiKeyAuth @Param org path string true "Name of provider organization" @Param vpcId path string true "ID of VPC" @Success 200 {object} model.APIVpcRoutingState @Router /v2/org/{org}/nico/vpc/{vpcId}/routing-profile [get]
type GetVpcPeeringHandler ¶
type GetVpcPeeringHandler struct {
// contains filtered or unexported fields
}
GetVpcPeeringHandler is the API Handler for getting a VPC Peering
func NewGetVpcPeeringHandler ¶
func NewGetVpcPeeringHandler(dbSession *cdb.Session, tc tclient.Client, cfg *config.Config) GetVpcPeeringHandler
NewGetVpcPeeringHandler initializes and returns a new handler to retrieve VPC Peering
func (GetVpcPeeringHandler) Handle ¶
func (gvph GetVpcPeeringHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve a VPC Peering @Description Retrieve a VPC Peering by ID for the current user @Tags vpcpeering @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of VPC Peering" @Param includeRelation query string false "Related entities to include in response e.g. 'Vpc1', 'Vpc2', 'Site', 'Tenant'"" @Success 200 {object} model.APIVpcPeering @Router /v2/org/{org}/nico/vpc-peering/{id} [get]
type GetVpcPrefixHandler ¶
type GetVpcPrefixHandler struct {
// contains filtered or unexported fields
}
GetVpcPrefixHandler is the API Handler for retrieving VPC prefix
func NewGetVpcPrefixHandler ¶
func NewGetVpcPrefixHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) GetVpcPrefixHandler
NewGetVpcPrefixHandler initializes and returns a new handler to retrieve VPC prefix
func (GetVpcPrefixHandler) Handle ¶
func (gsh GetVpcPrefixHandler) Handle(c echo.Context) error
Handle godoc @Summary Retrieve the VPC prefix @Description Retrieve the VPC prefix @Tags vpcprefix @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of VPC prefix" @Param includeRelation query string false "Related entities to include in response e.g. 'Site', 'Vpc', 'Tenant', 'IPv4Block', 'IPv6Block'" @Param includeUsageStats query boolean false "IPv4 usage (interface/instance-derived; same shape as IP Block usage)" @Success 200 {object} model.APIVpcPrefix @Router /v2/org/{org}/nico/vpcprefix/{id} [get]
type HealthCheckHandler ¶
type HealthCheckHandler struct{}
HealthCheckHandler is an API handler to return health status of the API server
func NewHealthCheckHandler ¶
func NewHealthCheckHandler() HealthCheckHandler
NewHealthCheckHandler creates and returns a new handler
func (HealthCheckHandler) Handle ¶
func (hch HealthCheckHandler) Handle(c echo.Context) error
Handle godoc @Summary Returns the health status of API server @Description Returns the health status of the API server @Tags health @Accept */* @Produce json @Success 200 {object} model.APIHealthCheck @Router /healthz [get]
type MachinePowerControlHandler ¶
type MachinePowerControlHandler struct {
// contains filtered or unexported fields
}
func NewMachinePowerControlHandler ¶
func NewMachinePowerControlHandler(dbSession *cdb.Session, scp *sc.ClientPool, _ *config.Config) MachinePowerControlHandler
func (MachinePowerControlHandler) Handle ¶
func (h MachinePowerControlHandler) Handle(c echo.Context) error
Handle godoc @Summary Machine Power Control @Description Power control a Machine. @Tags machine-power @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Param request body model.APIMachinePowerControlRequest true "Power control request" @Success 202 {object} model.APIMessageResponse @Router /v2/org/{org}/nico/machine/{machineId}/power [patch]
type MetadataHandler ¶
type MetadataHandler struct{}
MetadataHandler is an API handler to return system information about the API
func NewMetadataHandler ¶
func NewMetadataHandler() MetadataHandler
NewMetadataHandler creates and returns a new handler
func (MetadataHandler) Handle ¶
func (mdh MetadataHandler) Handle(c echo.Context) error
Handle godoc @Summary Returns system information about the API @Description Returns system information about the API @Tags metadata @Accept */* @Produce json @Success 200 {object} model.APIMetadata @Router /v2/org/{org}/nico/metadata [get]
type PauseTaskRunHandler ¶
type PauseTaskRunHandler struct {
// contains filtered or unexported fields
}
PauseTaskRunHandler pauses a running Run.
func NewPauseTaskRunHandler ¶
func NewPauseTaskRunHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) PauseTaskRunHandler
NewPauseTaskRunHandler initializes a new PauseTaskRunHandler.
func (PauseTaskRunHandler) Handle ¶
func (h PauseTaskRunHandler) Handle(c echo.Context) error
Handle godoc @Summary Pause a Run @Description Pause a running Run. In-flight target tasks continue; no new targets are claimed until resumed. @Tags run @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Run" @Param body body model.APITaskRunSiteRequest true "Pause run request" @Success 202 {object} model.APITaskRun @Router /v2/org/{org}/nico/task/run/{id}/pause [post]
type ReadinessCheckHandler ¶
type ReadinessCheckHandler struct {
// contains filtered or unexported fields
}
Check whether the API's PostgreSQL session can query the site table.
func NewReadinessCheckHandler ¶
func NewReadinessCheckHandler(dbSession *cdb.Session) ReadinessCheckHandler
Create a readiness handler using the API's non-nil database session.
type ReencryptTenantIdentitySecretsHandler ¶
type ReencryptTenantIdentitySecretsHandler struct {
// contains filtered or unexported fields
}
ReencryptTenantIdentitySecretsHandler handles POST /tenant-identity/re-encrypt.
func NewReencryptTenantIdentitySecretsHandler ¶
func NewReencryptTenantIdentitySecretsHandler(dbSession *cdb.Session, scp *sc.ClientPool) ReencryptTenantIdentitySecretsHandler
NewReencryptTenantIdentitySecretsHandler returns a new ReencryptTenantIdentitySecretsHandler.
func (ReencryptTenantIdentitySecretsHandler) Handle ¶
func (rtish ReencryptTenantIdentitySecretsHandler) Handle(c echo.Context) error
Handle godoc @Summary Reencrypt Tenant Identity Secrets @Description Re-wrap tenant_identity_config ciphertext with the site's current master encryption key (KEK rotation). Provider-admin scoped; the URL org identifies the provider. Omit organizationId to target all orgs, or set it to a tenant org that is associated with and has tenant identity configuration on the Site. @Tags TenantIdentity @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of provider organization" @Param siteID path string true "ID of target Site" @Param message body model.APITenantIdentityReencryptSecretsRequest true "Reencrypt Tenant Identity Secrets request" @Success 200 {object} model.APITenantIdentityReencryptSecretsResponse @Failure 503 {object} util.APIError @Router /v2/org/{org}/nico/site/{siteID}/tenant-identity/re-encrypt [post]
type ReleaseVPCInactiveVniHandler ¶
type ReleaseVPCInactiveVniHandler struct {
// contains filtered or unexported fields
}
ReleaseVPCInactiveVniHandler releases an allocation after operator convergence checks.
func NewReleaseVPCInactiveVniHandler ¶
func NewReleaseVPCInactiveVniHandler(dbSession *cdb.Session, scp *sc.ClientPool) ReleaseVPCInactiveVniHandler
NewReleaseVPCInactiveVniHandler returns a provider-only inactive VNI release handler.
func (ReleaseVPCInactiveVniHandler) Handle ¶
func (h ReleaseVPCInactiveVniHandler) Handle(c echo.Context) error
Handle godoc @Summary Release VPC Inactive VNI @Description Release the exact inactive allocation after independently verifying all affected consumers. @Tags vpc @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of provider organization" @Param vpcId path string true "ID of VPC" @Param request body model.APIVpcInactiveVniReleaseRequest true "Originally observed version and inactive VNI" @Success 200 {object} model.APIVpcInactiveVniReleaseResult @Router /v2/org/{org}/nico/vpc/{vpcId}/routing-profile/release-inactive-vni [post]
type ReplaceAllExpectedMachinesHandler ¶
type ReplaceAllExpectedMachinesHandler struct {
// contains filtered or unexported fields
}
ReplaceAllExpectedMachinesHandler replaces the complete ExpectedMachine set for one Site.
func NewReplaceAllExpectedMachinesHandler ¶
func NewReplaceAllExpectedMachinesHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) ReplaceAllExpectedMachinesHandler
NewReplaceAllExpectedMachinesHandler creates a full-Site ExpectedMachine replacement handler.
func (ReplaceAllExpectedMachinesHandler) Handle ¶
func (h ReplaceAllExpectedMachinesHandler) Handle(c echo.Context) error
Handle godoc @Summary Replace all ExpectedMachines for a Site @Description Replace the full set of ExpectedMachines for a Site; an empty list clears the set @Tags ExpectedMachine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIReplaceAllExpectedMachinesRequest true "ExpectedMachine replace-all request" @Success 200 {object} []model.APIExpectedMachine @Router /v2/org/{org}/nico/expected-machine/all [put]
type ReplaceAllExpectedPowerShelvesHandler ¶
type ReplaceAllExpectedPowerShelvesHandler struct {
// contains filtered or unexported fields
}
ReplaceAllExpectedPowerShelvesHandler replaces the complete ExpectedPowerShelf set for one Site.
func NewReplaceAllExpectedPowerShelvesHandler ¶
func NewReplaceAllExpectedPowerShelvesHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) ReplaceAllExpectedPowerShelvesHandler
NewReplaceAllExpectedPowerShelvesHandler creates a full-Site ExpectedPowerShelf replacement handler.
func (ReplaceAllExpectedPowerShelvesHandler) Handle ¶
func (h ReplaceAllExpectedPowerShelvesHandler) Handle(c echo.Context) error
Handle godoc @Summary Replace all ExpectedPowerShelves for a Site @Tags ExpectedPowerShelf @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIReplaceAllExpectedPowerShelvesRequest true "ExpectedPowerShelf replace-all request" @Success 200 {object} []model.APIExpectedPowerShelf @Router /v2/org/{org}/nico/expected-power-shelf/all [put]
type ReplaceAllExpectedRackGroupsHandler ¶
type ReplaceAllExpectedRackGroupsHandler struct {
// contains filtered or unexported fields
}
ReplaceAllExpectedRackGroupsHandler is the API Handler for replacing the full set of ExpectedRackGroups for a given Site with a provided list.
func NewReplaceAllExpectedRackGroupsHandler ¶
func NewReplaceAllExpectedRackGroupsHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) ReplaceAllExpectedRackGroupsHandler
NewReplaceAllExpectedRackGroupsHandler initializes and returns a new handler for replacing all ExpectedRackGroups on a Site
func (ReplaceAllExpectedRackGroupsHandler) Handle ¶
func (raerh ReplaceAllExpectedRackGroupsHandler) Handle(c echo.Context) error
Handle godoc @Summary Replace all ExpectedRackGroups for a Site @Description Replace the full set of ExpectedRackGroups for a given Site with the provided list @Tags ExpectedRackGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIReplaceAllExpectedRackGroupsRequest true "ExpectedRackGroup replace-all request" @Success 200 {object} []model.APIExpectedRackGroup @Router /v2/org/{org}/nico/expected-rack-group/all [put]
type ReplaceAllExpectedRacksHandler ¶
type ReplaceAllExpectedRacksHandler struct {
// contains filtered or unexported fields
}
ReplaceAllExpectedRacksHandler is the API Handler for replacing the full set of ExpectedRacks for a given Site with a provided list.
func NewReplaceAllExpectedRacksHandler ¶
func NewReplaceAllExpectedRacksHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) ReplaceAllExpectedRacksHandler
NewReplaceAllExpectedRacksHandler initializes and returns a new handler for replacing all ExpectedRacks on a Site
func (ReplaceAllExpectedRacksHandler) Handle ¶
func (raerh ReplaceAllExpectedRacksHandler) Handle(c echo.Context) error
Handle godoc @Summary Replace all ExpectedRacks for a Site @Description Replace the full set of ExpectedRacks for a given Site with the provided list @Tags ExpectedRack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIReplaceAllExpectedRacksRequest true "ExpectedRack replace-all request" @Success 200 {object} []model.APIExpectedRack @Router /v2/org/{org}/nico/expected-rack/all [put]
type ReplaceAllExpectedSwitchesHandler ¶
type ReplaceAllExpectedSwitchesHandler struct {
// contains filtered or unexported fields
}
ReplaceAllExpectedSwitchesHandler replaces the complete ExpectedSwitch set for one Site.
func NewReplaceAllExpectedSwitchesHandler ¶
func NewReplaceAllExpectedSwitchesHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) ReplaceAllExpectedSwitchesHandler
NewReplaceAllExpectedSwitchesHandler creates a full-Site ExpectedSwitch replacement handler.
func (ReplaceAllExpectedSwitchesHandler) Handle ¶
func (h ReplaceAllExpectedSwitchesHandler) Handle(c echo.Context) error
Handle godoc @Summary Replace all ExpectedSwitches for a Site @Tags ExpectedSwitch @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIReplaceAllExpectedSwitchesRequest true "ExpectedSwitch replace-all request" @Success 200 {object} []model.APIExpectedSwitch @Router /v2/org/{org}/nico/expected-switch/all [put]
type ReprovisionMachineDpuHandler ¶
type ReprovisionMachineDpuHandler struct {
// contains filtered or unexported fields
}
ReprovisionMachineDpuHandler triggers DPU reprovisioning for a Machine.
func NewReprovisionMachineDpuHandler ¶
func NewReprovisionMachineDpuHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) ReprovisionMachineDpuHandler
NewReprovisionMachineDpuHandler returns a new ReprovisionMachineDpuHandler.
func (ReprovisionMachineDpuHandler) Handle ¶
func (h ReprovisionMachineDpuHandler) Handle(c echo.Context) error
Handle godoc @Summary Trigger DPU Reprovisioning @Description Trigger DPU reprovisioning for a Machine. @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Param request body model.APIMachineDpuReprovisionRequest true "DPU reprovision request" @Success 202 {object} model.APIMessageResponse @Router /v2/org/{org}/nico/machine/{machineId}/dpu/reprovision [patch]
type ResetMachineBMCHandler ¶
type ResetMachineBMCHandler struct {
// contains filtered or unexported fields
}
ResetMachineBMCHandler resets a Machine BMC.
func NewResetMachineBMCHandler ¶
func NewResetMachineBMCHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) ResetMachineBMCHandler
NewResetMachineBMCHandler returns a new ResetMachineBMCHandler.
func (ResetMachineBMCHandler) Handle ¶
func (h ResetMachineBMCHandler) Handle(c echo.Context) error
Handle godoc @Summary Reset Machine BMC @Description Reset a Machine BMC. @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Param request body model.APIMachineBMCResetRequest true "Machine BMC reset request" @Success 202 {object} model.APIMessageResponse @Router /v2/org/{org}/nico/machine/{machineId}/bmc/reset [patch]
type ResetMachineChassisHandler ¶
type ResetMachineChassisHandler struct {
// contains filtered or unexported fields
}
ResetMachineChassisHandler queues a chassis reset for a Machine.
func NewResetMachineChassisHandler ¶
func NewResetMachineChassisHandler(dbSession *cdb.Session, scp *sc.ClientPool) ResetMachineChassisHandler
NewResetMachineChassisHandler returns a new ResetMachineChassisHandler.
func (ResetMachineChassisHandler) Handle ¶
func (h ResetMachineChassisHandler) Handle(c echo.Context) error
Handle godoc @Summary Reset Machine Chassis @Description Queue a Redfish chassis reset through the Machine Maintenance state. @Tags Machine @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param machineId path string true "ID of Machine" @Param chassisId path string true "Case-sensitive Redfish chassis identifier" @Success 202 {object} model.APIMessageResponse @Router /v2/org/{org}/nico/machine/{machineId}/chassis/{chassisId}/reset [patch]
type ResumeTaskRunHandler ¶
type ResumeTaskRunHandler struct {
// contains filtered or unexported fields
}
ResumeTaskRunHandler resumes an operator-paused Run.
func NewResumeTaskRunHandler ¶
func NewResumeTaskRunHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) ResumeTaskRunHandler
NewResumeTaskRunHandler initializes a new ResumeTaskRunHandler.
func (ResumeTaskRunHandler) Handle ¶
func (h ResumeTaskRunHandler) Handle(c echo.Context) error
Handle godoc @Summary Resume a Run @Description Resume an operator-paused Run. A Run paused at a phase gate must be advanced with the advance endpoint instead. @Tags run @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Run" @Param body body model.APITaskRunSiteRequest true "Resume run request" @Success 202 {object} model.APITaskRun @Router /v2/org/{org}/nico/task/run/{id}/resume [post]
type RotateCredentialHandler ¶
type RotateCredentialHandler struct {
// contains filtered or unexported fields
}
RotateCredentialHandler stages a site-wide credential rotation.
func NewRotateCredentialHandler ¶
func NewRotateCredentialHandler(dbSession *cdb.Session, scp *sc.ClientPool) RotateCredentialHandler
NewRotateCredentialHandler returns a handler that stages a credential rotation.
func (RotateCredentialHandler) Handle ¶
func (h RotateCredentialHandler) Handle(c echo.Context) error
Handle godoc @Summary Rotate Credential @Description Stage a site-wide credential rotation: publish a new rotate-to secret and bump the site-wide target version. Devices converge asynchronously; poll the status endpoint to observe convergence. Equivalent to `nico-admin-cli credential rotate`. @Tags credential-rotation @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param request body model.APICredentialRotationRequest true "Credential rotation" @Success 200 {object} model.APICredentialRotationResult @Router /v2/org/{org}/nico/credential/rotation [post]
type SiteExplorerEndpointActionHandler ¶
type SiteExplorerEndpointActionHandler struct {
// contains filtered or unexported fields
}
SiteExplorerEndpointActionHandler triggers clear-error or re-explore actions for explored endpoints.
func NewSiteExplorerEndpointActionHandler ¶
func NewSiteExplorerEndpointActionHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) SiteExplorerEndpointActionHandler
NewSiteExplorerEndpointActionHandler returns a handler for site-explorer endpoint actions.
func (SiteExplorerEndpointActionHandler) Handle ¶
func (h SiteExplorerEndpointActionHandler) Handle(c echo.Context) error
Handle godoc @Summary Trigger Site Explorer Endpoint Action @Description Trigger clear-error or re-explore for all or selected explored endpoints. @Tags site-explorer @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param request body model.APISiteExplorerEndpointActionRequest true "Site explorer endpoint action" @Success 200 {object} model.APISiteExplorerEndpointAction @Router /v2/org/{org}/nico/site-explorer/endpoint/action [post]
type UpdateAllocationConstraintHandler ¶
type UpdateAllocationConstraintHandler struct {
// contains filtered or unexported fields
}
UpdateAllocationConstraintHandler is the API Handler for updating a Allocation Constraint
func NewUpdateAllocationConstraintHandler ¶
func NewUpdateAllocationConstraintHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) UpdateAllocationConstraintHandler
NewUpdateAllocationConstraintHandler initializes and returns a new handler for updating Allocation Constraint
func (UpdateAllocationConstraintHandler) Handle ¶
func (uach UpdateAllocationConstraintHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing Allocation Constraint @Description Update an existing Allocation Constraint @Tags Allocation @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param allocation_id path string true "ID of Allocation" @Param id path string true "ID of Allocation Constraint" @Param message body model.APIAllocationConstraintUpdateRequest true "Allocation Constraint update request" @Success 200 {object} model.APIAllocationConstraint @Router /v2/org/{org}/nico/allocation/{allocation_id}/constraint/{id} [patch]
type UpdateAllocationHandler ¶
type UpdateAllocationHandler struct {
// contains filtered or unexported fields
}
UpdateAllocationHandler is the API Handler for updating a Allocation
func NewUpdateAllocationHandler ¶
func NewUpdateAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) UpdateAllocationHandler
NewUpdateAllocationHandler initializes and returns a new handler for updating Allocation
func (UpdateAllocationHandler) Handle ¶
func (uah UpdateAllocationHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing Allocation @Description Update an existing Allocation @Tags Allocation @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Allocation" @Param message body model.APIAllocationUpdateRequest true "Allocation update request" @Success 200 {object} model.APIAllocation @Router /v2/org/{org}/nico/allocation/{id} [patch]
type UpdateCurrentInfrastructureProviderHandler ¶
type UpdateCurrentInfrastructureProviderHandler struct {
// contains filtered or unexported fields
}
UpdateCurrentInfrastructureProviderHandler is the API Handler for updating the current Infrastructure Provider
func NewUpdateCurrentInfrastructureProviderHandler ¶
func NewUpdateCurrentInfrastructureProviderHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) UpdateCurrentInfrastructureProviderHandler
NewUpdateCurrentInfrastructureProviderHandler initializes and returns a new handler for updating the current Infrastructure Provider
func (UpdateCurrentInfrastructureProviderHandler) Handle ¶
func (uciph UpdateCurrentInfrastructureProviderHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing Infrastructure Provider @Description Update an existing Infrastructure Provider for the org @Tags infrastructureprovider @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIInfrastructureProviderUpdateRequest true "Infrastructure Provider update request" @Success 200 {object} model.APIInfrastructureProvider @Router /v2/org/{org}/nico/infrastructure-provider/current [patch]
type UpdateCurrentTenantHandler ¶
type UpdateCurrentTenantHandler struct {
// contains filtered or unexported fields
}
UpdateCurrentTenantHandler is the API Handler for updating the current Tenant
func NewUpdateCurrentTenantHandler ¶
func NewUpdateCurrentTenantHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) UpdateCurrentTenantHandler
NewUpdateCurrentTenantHandler initializes and returns a new handler for updating the current Tenant
func (UpdateCurrentTenantHandler) Handle ¶
func (ucth UpdateCurrentTenantHandler) Handle(c echo.Context) error
Handle godoc @Summary Update Tenant for org @Description Update the current Tenant for the org @Tags tenant @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APITenantUpdateRequest true "Tenant update request" @Success 200 {object} model.APITenant @Router /v2/org/{org}/nico/tenant/current [patch]
type UpdateDpuExtensionServiceHandler ¶
type UpdateDpuExtensionServiceHandler struct {
// contains filtered or unexported fields
}
UpdateDpuExtensionServiceHandler is the API Handler for updating a DPU Extension Service
func NewUpdateDpuExtensionServiceHandler ¶
func NewUpdateDpuExtensionServiceHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateDpuExtensionServiceHandler
NewUpdateDpuExtensionServiceHandler initializes and returns a new handler for updating DPU Extension Service
func (UpdateDpuExtensionServiceHandler) Handle ¶
func (udesh UpdateDpuExtensionServiceHandler) Handle(c echo.Context) error
Handle godoc @Summary Update a DPU Extension Service @Description Update a DPU Extension Service by ID. A new version will be created if data or credentials are modified. @Tags DPU Extension Service @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param dpuExtensionServiceId path string true "ID of DPU Extension Service" @Param message body model.APIDpuExtensionServiceUpdateRequest true "DPU Extension Service update request" @Success 200 {object} model.APIDpuExtensionService @Router /v2/org/{org}/nico/dpu-extension-service/{dpuExtensionServiceId} [patch]
type UpdateExpectedMachineHandler ¶
type UpdateExpectedMachineHandler struct {
// contains filtered or unexported fields
}
UpdateExpectedMachineHandler is the API Handler for updating a ExpectedMachine
func NewUpdateExpectedMachineHandler ¶
func NewUpdateExpectedMachineHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) UpdateExpectedMachineHandler
NewUpdateExpectedMachineHandler initializes and returns a new handler for updating ExpectedMachine
func (UpdateExpectedMachineHandler) Handle ¶
func (uemh UpdateExpectedMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing ExpectedMachine @Description Update an existing ExpectedMachine by ID @Tags ExpectedMachine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Machine" @Param message body model.APIExpectedMachineUpdateRequest true "ExpectedMachine update request" @Success 200 {object} model.APIExpectedMachine @Router /v2/org/{org}/nico/expected-machine/{id} [patch]
type UpdateExpectedMachinesHandler ¶
type UpdateExpectedMachinesHandler struct {
// contains filtered or unexported fields
}
UpdateExpectedMachinesHandler is the API Handler for batch updating ExpectedMachines
func NewUpdateExpectedMachinesHandler ¶
func NewUpdateExpectedMachinesHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) UpdateExpectedMachinesHandler
NewUpdateExpectedMachinesHandler initializes and returns a new handler for batch updating ExpectedMachines
func (UpdateExpectedMachinesHandler) Handle ¶
func (uemh UpdateExpectedMachinesHandler) Handle(c echo.Context) error
Handle godoc @Summary Batch update ExpectedMachines @Description Update multiple ExpectedMachines in a single request. All machines must belong to the same site. @Tags ExpectedMachine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body []model.APIExpectedMachineUpdateRequest true "ExpectedMachine UpdateExpectedMachines request" @Success 200 {object} model.APIExpectedMachineBatchResponse @Router /v2/org/{org}/nico/expected-machine/batch [patch]
type UpdateExpectedPowerShelfHandler ¶
type UpdateExpectedPowerShelfHandler struct {
// contains filtered or unexported fields
}
UpdateExpectedPowerShelfHandler is the API Handler for updating a ExpectedPowerShelf
func NewUpdateExpectedPowerShelfHandler ¶
func NewUpdateExpectedPowerShelfHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) UpdateExpectedPowerShelfHandler
NewUpdateExpectedPowerShelfHandler initializes and returns a new handler for updating ExpectedPowerShelf
func (UpdateExpectedPowerShelfHandler) Handle ¶
func (uepsh UpdateExpectedPowerShelfHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing ExpectedPowerShelf @Description Update an existing ExpectedPowerShelf by ID @Tags ExpectedPowerShelf @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Power Shelf" @Param message body model.APIExpectedPowerShelfUpdateRequest true "ExpectedPowerShelf update request" @Success 200 {object} model.APIExpectedPowerShelf @Router /v2/org/{org}/nico/expected-power-shelf/{id} [patch]
type UpdateExpectedRackGroupHandler ¶
type UpdateExpectedRackGroupHandler struct {
// contains filtered or unexported fields
}
UpdateExpectedRackGroupHandler is the API Handler for updating an ExpectedRackGroup
func NewUpdateExpectedRackGroupHandler ¶
func NewUpdateExpectedRackGroupHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) UpdateExpectedRackGroupHandler
NewUpdateExpectedRackGroupHandler initializes and returns a new handler for updating ExpectedRackGroup
func (UpdateExpectedRackGroupHandler) Handle ¶
func (uerh UpdateExpectedRackGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing ExpectedRackGroup @Description Update an existing ExpectedRackGroup by ID @Tags ExpectedRackGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Rack Group" @Param message body model.APIExpectedRackGroupUpdateRequest true "ExpectedRackGroup update request" @Success 200 {object} model.APIExpectedRackGroup @Router /v2/org/{org}/nico/expected-rack-group/{id} [patch]
type UpdateExpectedRackHandler ¶
type UpdateExpectedRackHandler struct {
// contains filtered or unexported fields
}
UpdateExpectedRackHandler is the API Handler for updating an ExpectedRack
func NewUpdateExpectedRackHandler ¶
func NewUpdateExpectedRackHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) UpdateExpectedRackHandler
NewUpdateExpectedRackHandler initializes and returns a new handler for updating ExpectedRack
func (UpdateExpectedRackHandler) Handle ¶
func (uerh UpdateExpectedRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing ExpectedRack @Description Update an existing ExpectedRack by ID @Tags ExpectedRack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Rack" @Param message body model.APIExpectedRackUpdateRequest true "ExpectedRack update request" @Success 200 {object} model.APIExpectedRack @Router /v2/org/{org}/expected-rack/{id} [patch]
type UpdateExpectedSwitchHandler ¶
type UpdateExpectedSwitchHandler struct {
// contains filtered or unexported fields
}
UpdateExpectedSwitchHandler is the API Handler for updating a ExpectedSwitch
func NewUpdateExpectedSwitchHandler ¶
func NewUpdateExpectedSwitchHandler(dbSession *cdb.Session, scp *sc.ClientPool, cfg *config.Config) UpdateExpectedSwitchHandler
NewUpdateExpectedSwitchHandler initializes and returns a new handler for updating ExpectedSwitch
func (UpdateExpectedSwitchHandler) Handle ¶
func (uesh UpdateExpectedSwitchHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing ExpectedSwitch @Description Update an existing ExpectedSwitch by ID @Tags ExpectedSwitch @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Expected Switch" @Param message body model.APIExpectedSwitchUpdateRequest true "ExpectedSwitch update request" @Success 200 {object} model.APIExpectedSwitch @Router /v2/org/{org}/nico/expected-switch/{id} [patch]
type UpdateIPBlockHandler ¶
type UpdateIPBlockHandler struct {
// contains filtered or unexported fields
}
UpdateIPBlockHandler is the API Handler for updating a IPBlock
func NewUpdateIPBlockHandler ¶
func NewUpdateIPBlockHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) UpdateIPBlockHandler
NewUpdateIPBlockHandler initializes and returns a new handler for updating IPBlock
func (UpdateIPBlockHandler) Handle ¶
func (uipbh UpdateIPBlockHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing IPBlock @Description Update an existing IPBlock @Tags IPBlock @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of IPBlock" @Param message body model.APIIPBlockUpdateRequest true "IPBlock update request" @Success 200 {object} model.APIIPBlock @Router /v2/org/{org}/nico/ipblock/{id} [patch]
type UpdateInfiniBandPartitionHandler ¶
type UpdateInfiniBandPartitionHandler struct {
// contains filtered or unexported fields
}
UpdateInfiniBandPartitionHandler is the API Handler for updating a InfiniBandPartition
func NewUpdateInfiniBandPartitionHandler ¶
func NewUpdateInfiniBandPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateInfiniBandPartitionHandler
NewUpdateInfiniBandPartitionHandler initializes and returns a new handler for updating InfiniBandPartition
func (UpdateInfiniBandPartitionHandler) Handle ¶
func (uibph UpdateInfiniBandPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing InfiniBandPartition @Description Update an existing InfiniBandPartition @Tags InfiniBandPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of InfiniBandPartition" @Param message body model.APIInfiniBandPartitionUpdateRequest true "InfiniBandPartition update request" @Success 200 {object} model.APIInfiniBandPartition @Router /v2/org/{org}/nico/infiniband-partition/{id} [patch]
type UpdateInstanceHandler ¶
type UpdateInstanceHandler struct {
// contains filtered or unexported fields
}
UpdateInstanceHandler is the API Handler for updating an Instance
func NewUpdateInstanceHandler ¶
func NewUpdateInstanceHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config, dps dpsclient.PowerProvisioner) UpdateInstanceHandler
NewUpdateInstanceHandler initializes and returns a new handler for updating Instance
func (UpdateInstanceHandler) Handle ¶
func (uih UpdateInstanceHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing Instance @Description Update an existing Instance for the org @Tags Instance @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Instance" @Param message body model.APIInstanceUpdateRequest true "Instance update request" @Success 200 {object} model.APIInstance @Router /v2/org/{org}/nico/instance/{id} [patch]
type UpdateInstanceTypeHandler ¶
type UpdateInstanceTypeHandler struct {
// contains filtered or unexported fields
}
UpdateInstanceTypeHandler is the API Handler for updating an Instance Type
func NewUpdateInstanceTypeHandler ¶
func NewUpdateInstanceTypeHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateInstanceTypeHandler
NewUpdateInstanceTypeHandler initializes and returns a new handler for updating Instance Type
func (UpdateInstanceTypeHandler) Handle ¶
func (uith UpdateInstanceTypeHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing Instance Type @Description Update an existing Instance Type. Org's Infrastructure Provider must be associated with the Instance Type. @Tags instancetype @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id query string true "ID of Instance Type" @Param message body model.APIInstanceTypeUpdateRequest true "Instance Type update request" @Success 200 {object} model.APIInstanceType @Router /v2/org/{org}/nico/instance/type/{id} [patch]
type UpdateMachineHandler ¶
type UpdateMachineHandler struct {
// contains filtered or unexported fields
}
UpdateMachineHandler is the API Handler for updating a Machine
func NewUpdateMachineHandler ¶
func NewUpdateMachineHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateMachineHandler
NewUpdateMachineHandler initializes and returns a new handler to update Machine
func (UpdateMachineHandler) Handle ¶
func (umh UpdateMachineHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing Machine @Description Update an existing Machine for the org @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Machine" @Param message body model.APIMachineUpdateRequest true "Machine update request" @Success 200 {object} model.APIMachine @Router /v2/org/{org}/nico/machine/{id} [patch]
type UpdateMachineSpectrumXMultiplaneHandler ¶
type UpdateMachineSpectrumXMultiplaneHandler struct {
// contains filtered or unexported fields
}
UpdateMachineSpectrumXMultiplaneHandler patches desired maintenance configuration.
func NewUpdateMachineSpectrumXMultiplaneHandler ¶
func NewUpdateMachineSpectrumXMultiplaneHandler(dbSession *cdb.Session, scp *sc.ClientPool) UpdateMachineSpectrumXMultiplaneHandler
NewUpdateMachineSpectrumXMultiplaneHandler returns the machine multiplane update handler.
func (UpdateMachineSpectrumXMultiplaneHandler) Handle ¶
func (h UpdateMachineSpectrumXMultiplaneHandler) Handle(c echo.Context) error
Handle godoc @Summary Update Machine Spectrum-X Multiplane @Description Atomically change selected rails and planes. Assigned Machines require acknowledgeAttachedInstance=true. True maintenanceMode disables the selected links. The response confirms saved configuration; DPU observations converge asynchronously. For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with `PROVIDER_ADMIN` suffix. @Tags machine @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param machineId path string true "ID of Machine" @Param request body model.APIMachineSpectrumXMultiplaneUpdateRequest true "Maintenance selection" @Success 200 {object} model.APIMachineSpectrumXMultiplane @Router /v2/org/{org}/nico/machine/{machineId}/spectrumx-multiplane [patch]
type UpdateMachineValidationExternalConfigHandler ¶
type UpdateMachineValidationExternalConfigHandler struct {
// contains filtered or unexported fields
}
UpdateMachineValidationExternalConfigHandler is the API Handler for update existing MachineValidationExternalConfig
func NewUpdateMachineValidationExternalConfigHandler ¶
func NewUpdateMachineValidationExternalConfigHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateMachineValidationExternalConfigHandler
NewUpdateMachineValidationExternalConfigHandler initializes and returns a new handler for updating MachineValidationExternalConfig
func (UpdateMachineValidationExternalConfigHandler) Handle ¶
func (handler UpdateMachineValidationExternalConfigHandler) Handle(c echo.Context) error
Handle godoc @Summary Update a MachineValidationExternalConfig @Description Update a MachineValidationExternalConfig @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIMachineValidationExternalConfigUpdateRequest true "MachineValidationExternalConfig update request" @Success 200 {object} model.APIMachineValidationExternalConfig @Router /v2/org/{org}/nico/site/{site}/machine-validation/external-config/{name} [patch]
type UpdateMachineValidationTestHandler ¶
type UpdateMachineValidationTestHandler struct {
// contains filtered or unexported fields
}
UpdateMachineValidationTestHandler is the API Handler for update existing MachineValidationTest
func NewUpdateMachineValidationTestHandler ¶
func NewUpdateMachineValidationTestHandler(dbSession *cdb.Session, tc tclient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateMachineValidationTestHandler
NewUpdateMachineValidationTestHandler initializes and returns a new handler for updating MachineValidationTest
func (UpdateMachineValidationTestHandler) Handle ¶
func (handler UpdateMachineValidationTestHandler) Handle(c echo.Context) error
Handle godoc @Summary Update a MachineValidationTest @Description Update a MachineValidationTest @Tags MachineValidationTest @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APIMachineValidationTestUpdateRequest true "MachineValidationTest update request" @Success 201 {object} model.APIMachineValidationTest @Router /v2/org/{org}/nico/site/{site}/machine-validation/test/{id}/version/{version} [patch]
type UpdateNVLinkDomainFirmwareHandler ¶
type UpdateNVLinkDomainFirmwareHandler struct {
// contains filtered or unexported fields
}
UpdateNVLinkDomainFirmwareHandler updates firmware on one NVLink Domain identified by UUID.
func NewUpdateNVLinkDomainFirmwareHandler ¶
func NewUpdateNVLinkDomainFirmwareHandler( dbSession *cdb.Session, scp *sc.ClientPool, ) UpdateNVLinkDomainFirmwareHandler
NewUpdateNVLinkDomainFirmwareHandler initializes an NVLink Domain firmware-update handler.
func (UpdateNVLinkDomainFirmwareHandler) Handle ¶
func (h UpdateNVLinkDomainFirmwareHandler) Handle(c echo.Context) error
Handle godoc @Summary Firmware update an NVLink Domain @Description Update firmware on an NVLink Domain identified by ID. @Tags domain @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the NVLink Domain" @Param body body model.APINVLinkDomainFirmwareUpdateRequest true "NVLink Domain firmware update request" @Success 200 {object} model.APIUpdateFirmwareResponse @Router /v2/org/{org}/nico/domain/nvlink/{id}/firmware [patch]
type UpdateNVLinkDomainPowerStateHandler ¶
type UpdateNVLinkDomainPowerStateHandler struct {
// contains filtered or unexported fields
}
UpdateNVLinkDomainPowerStateHandler power controls one NVLink Domain identified by ID.
func NewUpdateNVLinkDomainPowerStateHandler ¶
func NewUpdateNVLinkDomainPowerStateHandler( dbSession *cdb.Session, scp *sc.ClientPool, ) UpdateNVLinkDomainPowerStateHandler
NewUpdateNVLinkDomainPowerStateHandler initializes an NVLink Domain power-control handler.
func (UpdateNVLinkDomainPowerStateHandler) Handle ¶
func (h UpdateNVLinkDomainPowerStateHandler) Handle(c echo.Context) error
Handle godoc @Summary Power control an NVLink Domain @Description Power control an NVLink Domain identified by ID. @Tags domain @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the NVLink Domain" @Param body body model.APIUpdatePowerStateRequest true "NVLink Domain power control request" @Success 200 {object} model.APIUpdatePowerStateResponse @Router /v2/org/{org}/nico/domain/nvlink/{id}/power [patch]
type UpdateNVLinkLogicalPartitionHandler ¶
type UpdateNVLinkLogicalPartitionHandler struct {
// contains filtered or unexported fields
}
UpdateNVLinkLogicalPartitionHandler is the API Handler for updating a NVLinkLogicalPartition
func NewUpdateNVLinkLogicalPartitionHandler ¶
func NewUpdateNVLinkLogicalPartitionHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateNVLinkLogicalPartitionHandler
NewUpdateNVLinkLogicalPartitionHandler initializes and returns a new handler for updating NVLinkLogicalPartition
func (UpdateNVLinkLogicalPartitionHandler) Handle ¶
func (uibph UpdateNVLinkLogicalPartitionHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing NVLinkLogicalPartition @Description Update an existing NVLinkLogicalPartition @Tags NVLinkLogicalPartition @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of NVLinkLogicalPartition" @Param message body model.APINVLinkLogicalPartitionUpdateRequest true "NVLinkLogicalPartition update request" @Success 200 {object} model.APINVLinkLogicalPartition @Router /v2/org/{org}/nico/nvlink-logical-partition/{id} [patch]
type UpdateNetworkSecurityGroupHandler ¶
type UpdateNetworkSecurityGroupHandler struct {
// contains filtered or unexported fields
}
DeleteNetworkSecurityGroupHandler is the API Handler for deleting a new NetworkSecurityGroup
func NewUpdateNetworkSecurityGroupHandler ¶
func NewUpdateNetworkSecurityGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateNetworkSecurityGroupHandler
NewDeleteNetworkSecurityGroupHandler initializes and returns a new handler for creating NetworkSecurityGroup
func (UpdateNetworkSecurityGroupHandler) Handle ¶
func (dnsgh UpdateNetworkSecurityGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Update a NetworkSecurityGroup @Description Update a NetworkSecurityGroup @Tags NetworkSecurityGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param message body model.APINetworkSecurityGroupUpdateRequest true "NetworkSecurityGroup update request" @Success 200 {object} model.APINetworkSecurityGroup @Router /v2/org/{org}/nico/network-security-group [post]
type UpdateOperatingSystemHandler ¶
type UpdateOperatingSystemHandler struct {
// contains filtered or unexported fields
}
UpdateOperatingSystemHandler is the API Handler for updating a OperatingSystem
func NewUpdateOperatingSystemHandler ¶
func NewUpdateOperatingSystemHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateOperatingSystemHandler
NewUpdateOperatingSystemHandler initializes and returns a new handler for updating OperatingSystem
func (UpdateOperatingSystemHandler) Handle ¶
func (ush UpdateOperatingSystemHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing OperatingSystem @Description Update an existing OperatingSystem @Tags OperatingSystem @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of OperatingSystem" @Param message body model.APIOperatingSystemUpdateRequest true "OperatingSystem update request" @Success 200 {object} model.APIOperatingSystem @Router /v2/org/{org}/nico/operating-system/{id} [patch]
type UpdateRackFirmwareHandler ¶
type UpdateRackFirmwareHandler struct {
// contains filtered or unexported fields
}
UpdateRackFirmwareHandler is the API Handler for upgrading firmware on a single Rack by ID
func NewUpdateRackFirmwareHandler ¶
func NewUpdateRackFirmwareHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateRackFirmwareHandler
NewUpdateRackFirmwareHandler initializes and returns a new handler for firmware upgrading a Rack
func (UpdateRackFirmwareHandler) Handle ¶
func (furh UpdateRackFirmwareHandler) Handle(c echo.Context) error
Handle godoc @Summary Firmware update a Rack @Description Update firmware on a Rack identified by Rack ID. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "Rack ID" @Param body body model.APIUpdateFirmwareRequest true "Firmware update request" @Success 200 {object} model.APIUpdateFirmwareResponse @Router /v2/org/{org}/nico/rack/{id}/firmware [patch]
type UpdateRackPowerStateHandler ¶
type UpdateRackPowerStateHandler struct {
// contains filtered or unexported fields
}
UpdateRackPowerStateHandler is the API Handler for power controlling a single Rack by ID
func NewUpdateRackPowerStateHandler ¶
func NewUpdateRackPowerStateHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateRackPowerStateHandler
NewUpdateRackPowerStateHandler initializes and returns a new handler for power controlling a Rack
func (UpdateRackPowerStateHandler) Handle ¶
func (pcrh UpdateRackPowerStateHandler) Handle(c echo.Context) error
Handle godoc @Summary Power control a Rack @Description Power control a Rack identified by Rack ID (On, Off, Cycle, ForceOff, ForceCycle, ACPowerCycle) @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Rack" @Param body body model.APIUpdatePowerStateRequest true "Power control request" @Success 200 {object} model.APIUpdatePowerStateResponse @Router /v2/org/{org}/nico/rack/{id}/power [patch]
type UpdateSSHKeyGroupHandler ¶
type UpdateSSHKeyGroupHandler struct {
// contains filtered or unexported fields
}
UpdateSSHKeyGroupHandler is the API Handler for updating an SSH Key Group
func NewUpdateSSHKeyGroupHandler ¶
func NewUpdateSSHKeyGroupHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) UpdateSSHKeyGroupHandler
NewUpdateSSHKeyGroupHandler initializes and returns a new handler for updating SSH Key Group
func (UpdateSSHKeyGroupHandler) Handle ¶
func (uskgh UpdateSSHKeyGroupHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing SSH Key Group @Description Update an existing SSH Key Group for the org @Tags SSHKeyGroup @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of SSH Key Group" @Param message body model.APISSHKeyGroupUpdateRequest true "SSH Key Group update request" @Success 200 {object} model.SSHKeyGroup @Router /v2/org/{org}/nico/sshkeygroup/{id} [patch]
type UpdateSSHKeyHandler ¶
type UpdateSSHKeyHandler struct {
// contains filtered or unexported fields
}
UpdateSSHKeyHandler is the API Handler for updating a SSH Key
func NewUpdateSSHKeyHandler ¶
func NewUpdateSSHKeyHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) UpdateSSHKeyHandler
NewUpdateSSHKeyHandler initializes and returns a new handler for updating SSH Key
func (UpdateSSHKeyHandler) Handle ¶
func (uskh UpdateSSHKeyHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing SSH Key @Description Update an existing SSH Key for the org @Tags SSHKey @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of SSHKey" @Param message body model.APISSHKeyUpdateRequest true "SSH Key update request" @Success 200 {object} model.APISSHKey @Router /v2/org/{org}/nico/sshkey/{id} [patch]
type UpdateSiteHandler ¶
type UpdateSiteHandler struct {
// contains filtered or unexported fields
}
UpdateSiteHandler is the API Handler for updating a Site
func NewUpdateSiteHandler ¶
func NewUpdateSiteHandler(dbSession *cdb.Session, tc tClient.Client, cfg *config.Config) UpdateSiteHandler
NewUpdateSiteHandler initializes and returns a new handler for updating Site
func (UpdateSiteHandler) Handle ¶
func (ush UpdateSiteHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing Site @Description Update an existing Site for the org @Tags site @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Site" @Param message body model.APISiteUpdateRequest true "Site update request" @Success 200 {object} model.APISite @Router /v2/org/{org}/nico/site/{id} [patch]
type UpdateSkuHandler ¶
type UpdateSkuHandler struct {
// contains filtered or unexported fields
}
UpdateSkuHandler partially updates one SKU on a Site's Core service.
func NewUpdateSkuHandler ¶
func NewUpdateSkuHandler(dbSession *cdb.Session, scp *sc.ClientPool) UpdateSkuHandler
NewUpdateSkuHandler returns a new UpdateSkuHandler.
func (UpdateSkuHandler) Handle ¶
func (ush UpdateSkuHandler) Handle(c echo.Context) error
Handle godoc @Summary Update SKU @Description Update selected mutable fields on a SKU. @Tags SKU @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "SKU ID" @Param request body model.APISkuUpdateRequest true "SKU update request" @Success 200 {object} model.APISku @Router /v2/org/{org}/nico/sku/{id} [patch]
type UpdateSubnetHandler ¶
type UpdateSubnetHandler struct {
// contains filtered or unexported fields
}
UpdateSubnetHandler is the API Handler for updating a Subnet
func NewUpdateSubnetHandler ¶
func NewUpdateSubnetHandler(dbSession *cdb.Session, tc temporalClient.Client, cfg *config.Config) UpdateSubnetHandler
NewUpdateSubnetHandler initializes and returns a new handler for updating Subnet
func (UpdateSubnetHandler) Handle ¶
func (ush UpdateSubnetHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing Subnet @Description Update an existing Subnet @Tags Subnet @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Subnet" @Param message body model.APISubnetUpdateRequest true "Subnet update request" @Success 200 {object} model.APISubnet @Router /v2/org/{org}/nico/subnet/{id} [patch]
type UpdateTaskRuleHandler ¶
type UpdateTaskRuleHandler struct {
// contains filtered or unexported fields
}
UpdateTaskRuleHandler is the API Handler for updating an Operation Rule.
func NewUpdateTaskRuleHandler ¶
func NewUpdateTaskRuleHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateTaskRuleHandler
NewUpdateTaskRuleHandler initializes a new UpdateTaskRuleHandler.
func (UpdateTaskRuleHandler) Handle ¶
func (h UpdateTaskRuleHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an Operation Rule @Description Patch a Rule's mutable fields (name, description, ruleDefinition). operationType and operationCode are immutable; create a new rule to change them. @Tags rule @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "UUID of the Rule" @Param body body model.APITaskRuleUpdateRequest true "Update rule request" @Success 204 "No Content" @Router /v2/org/{org}/nico/task/rule/{id} [patch]
type UpdateTenantAccountHandler ¶
type UpdateTenantAccountHandler struct {
// contains filtered or unexported fields
}
UpdateTenantAccountHandler is the API Handler for updating a TenantAccount
func NewUpdateTenantAccountHandler ¶
func NewUpdateTenantAccountHandler(dbSession *cdb.Session, scp *sc.ClientPool, tc temporalClient.Client, cfg *config.Config) UpdateTenantAccountHandler
NewUpdateTenantAccountHandler initializes and returns a new handler for updating Tenant
func (UpdateTenantAccountHandler) Handle ¶
func (utah UpdateTenantAccountHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing TenantAccount @Description Update an existing TenantAccount @Tags tenantaccount @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Tenant Account" @Param message body model.APITenantAccountUpdateRequest true "TenantAccount update request" @Success 200 {object} model.APITenantAccount @Router /v2/org/{org}/nico/tenant/account/{id} [patch]
type UpdateTrayFirmwareHandler ¶
type UpdateTrayFirmwareHandler struct {
// contains filtered or unexported fields
}
UpdateTrayFirmwareHandler is the API Handler for upgrading firmware on a single Tray by ID
func NewUpdateTrayFirmwareHandler ¶
func NewUpdateTrayFirmwareHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateTrayFirmwareHandler
NewUpdateTrayFirmwareHandler initializes and returns a new handler for firmware upgrading a Tray
func (UpdateTrayFirmwareHandler) Handle ¶
func (futh UpdateTrayFirmwareHandler) Handle(c echo.Context) error
Handle godoc @Summary Firmware update a Tray @Description Update firmware on a Tray identified by component ID. @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "Component ID" @Param body body model.APIUpdateFirmwareRequest true "Firmware update request" @Success 200 {object} model.APIUpdateFirmwareResponse @Router /v2/org/{org}/nico/tray/{id}/firmware [patch]
type UpdateTrayPowerStateHandler ¶
type UpdateTrayPowerStateHandler struct {
// contains filtered or unexported fields
}
UpdateTrayPowerStateHandler is the API Handler for power controlling a single Tray by ID
func NewUpdateTrayPowerStateHandler ¶
func NewUpdateTrayPowerStateHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateTrayPowerStateHandler
NewUpdateTrayPowerStateHandler initializes and returns a new handler for power controlling a Tray
func (UpdateTrayPowerStateHandler) Handle ¶
func (pcth UpdateTrayPowerStateHandler) Handle(c echo.Context) error
Handle godoc @Summary Power control a Tray @Description Power control a Tray identified by component ID (On, Off, Cycle, ForceOff, ForceCycle, ACPowerCycle) @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Tray" @Param body body model.APIUpdatePowerStateRequest true "Power control request" @Success 200 {object} model.APIUpdatePowerStateResponse @Router /v2/org/{org}/nico/tray/{id}/power [patch]
type UpdateVPCHandler ¶
type UpdateVPCHandler struct {
// contains filtered or unexported fields
}
UpdateVPCHandler is the API Handler for updating a VPC
func NewUpdateVPCHandler ¶
func NewUpdateVPCHandler(dbSession *cdb.Session, tc temporalClient.Client, sc *sc.ClientPool, cfg *config.Config, dps dpsclient.PowerProvisioner) UpdateVPCHandler
NewUpdateVPCHandler initializes and returns a new handler for updating VPC
func (UpdateVPCHandler) Handle ¶
func (uvh UpdateVPCHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing VPC @Description Update an existing VPC for the org @Tags vpc @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Vpc" @Param message body model.APIVpcUpdateRequest true "VPC update request" @Success 200 {object} model.APIVpc @Router /v2/org/{org}/nico/vpc/{id} [patch]
type UpdateVPCRoutingProfileHandler ¶
type UpdateVPCRoutingProfileHandler struct {
// contains filtered or unexported fields
}
UpdateVPCRoutingProfileHandler changes a profile with one internally observed version.
func NewUpdateVPCRoutingProfileHandler ¶
func NewUpdateVPCRoutingProfileHandler(dbSession *cdb.Session, scp *sc.ClientPool) UpdateVPCRoutingProfileHandler
NewUpdateVPCRoutingProfileHandler returns a provider-only routing update handler.
func (UpdateVPCRoutingProfileHandler) Handle ¶
func (h UpdateVPCRoutingProfileHandler) Handle(c echo.Context) error
Handle godoc @Summary Update VPC Routing Profile @Description Change the profile and active VNI, retaining the previous allocation until explicit release. @Tags vpc @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of provider organization" @Param vpcId path string true "ID of VPC" @Param request body model.APIVpcRoutingProfileUpdateRequest true "Destination profile and optional VNI" @Success 200 {object} model.APIVpcRoutingState @Router /v2/org/{org}/nico/vpc/{vpcId}/routing-profile [patch]
type UpdateVPCVirtualizationHandler ¶
type UpdateVPCVirtualizationHandler struct {
// contains filtered or unexported fields
}
UpdateVPCVirtualizationHandler is the API Handler for updating virtualization of a VPC
func NewUpdateVPCVirtualizationHandler ¶
func NewUpdateVPCVirtualizationHandler(dbSession *cdb.Session, tc temporalClient.Client, sc *sc.ClientPool, cfg *config.Config) UpdateVPCVirtualizationHandler
NewUpdateVPCVirtualizationHandler initializes and returns a new handler for updating virtualization of a VPC
func (UpdateVPCVirtualizationHandler) Handle ¶
func (uvvh UpdateVPCVirtualizationHandler) Handle(c echo.Context) error
Handle godoc @Summary Update virtualization of a VPC @Description Update the network virtualization of a VPC @Tags vpc @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of Vpc" @Param message body model.APIVpcVirtualizationUpdateRequest true "VPC virtualization update request" @Success 200 {object} model.APIVpc @Router /v2/org/{org}/nico/vpc/{id}/virtualization [patch]
type UpdateVpcPrefixHandler ¶
type UpdateVpcPrefixHandler struct {
// contains filtered or unexported fields
}
UpdateVpcPrefixHandler is the API Handler for updating a VPC prefix
func NewUpdateVpcPrefixHandler ¶
func NewUpdateVpcPrefixHandler(dbSession *cdb.Session, tc temporalClient.Client, scp *sc.ClientPool, cfg *config.Config) UpdateVpcPrefixHandler
NewUpdateVpcPrefixHandler initializes and returns a new handler for updating VPC prefix
func (UpdateVpcPrefixHandler) Handle ¶
func (ush UpdateVpcPrefixHandler) Handle(c echo.Context) error
Handle godoc @Summary Update an existing VPC prefix @Description Update an existing VPC prefix @Tags vpcprefix @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of VPC prefix" @Param message body model.APIVpcPrefixUpdateRequest true "VPC prefix update request" @Success 200 {object} model.APIVpcPrefix @Router /v2/org/{org}/nico/vpcprefix/{id} [patch]
type ValidateRackHandler ¶
type ValidateRackHandler struct {
// contains filtered or unexported fields
}
ValidateRackHandler is the API Handler for validating a Rack's components
func NewValidateRackHandler ¶
func NewValidateRackHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) ValidateRackHandler
NewValidateRackHandler initializes and returns a new handler for validating a Rack
func (ValidateRackHandler) Handle ¶
func (vrh ValidateRackHandler) Handle(c echo.Context) error
Handle godoc @Summary Validate a Rack @Description Validate a Rack's components by comparing expected vs actual state via Flow @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of the Rack" @Param siteId query string true "ID of the Site" @Success 200 {object} model.APIRackValidationResult @Router /v2/org/{org}/nico/rack/{id}/validation [get]
type ValidateRacksHandler ¶
type ValidateRacksHandler struct {
// contains filtered or unexported fields
}
ValidateRacksHandler is the API Handler for validating Racks with optional filters. If no filter is specified, validates all racks in the Site.
func NewValidateRacksHandler ¶
func NewValidateRacksHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) ValidateRacksHandler
NewValidateRacksHandler initializes and returns a new handler for validating Racks
func (ValidateRacksHandler) Handle ¶
func (vrsh ValidateRacksHandler) Handle(c echo.Context) error
Handle godoc @Summary Validate Racks @Description Validate Rack components by comparing expected vs actual state via Flow. If no filter is specified, validates all racks in the Site. @Tags rack @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of the Site" @Param name query string false "Filter racks by name" @Param manufacturer query string false "Filter racks by manufacturer" @Success 200 {object} model.APIRackValidationResult @Router /v2/org/{org}/nico/rack/validation [get]
type ValidateTrayHandler ¶
type ValidateTrayHandler struct {
// contains filtered or unexported fields
}
ValidateTrayHandler is the API Handler for validating a single Tray's components
func NewValidateTrayHandler ¶
func NewValidateTrayHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) ValidateTrayHandler
NewValidateTrayHandler initializes and returns a new handler for validating a Tray
func (ValidateTrayHandler) Handle ¶
func (vth ValidateTrayHandler) Handle(c echo.Context) error
Handle godoc @Summary Validate a Tray @Description Validate a Tray by comparing expected vs actual state via Flow @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param id path string true "ID of the Tray" @Param siteId query string true "ID of the Site" @Success 200 {object} model.APIRackValidationResult @Router /v2/org/{org}/nico/tray/{id}/validation [get]
type ValidateTraysHandler ¶
type ValidateTraysHandler struct {
// contains filtered or unexported fields
}
ValidateTraysHandler is the API Handler for validating Trays with optional filters. If no filter is specified, validates all trays in the Site.
func NewValidateTraysHandler ¶
func NewValidateTraysHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.ClientPool, cfg *config.Config) ValidateTraysHandler
NewValidateTraysHandler initializes and returns a new handler for validating Trays
func (ValidateTraysHandler) Handle ¶
func (vtsh ValidateTraysHandler) Handle(c echo.Context) error
Handle godoc @Summary Validate Trays @Description Validate Tray components by comparing expected vs actual state via Flow. If no filter is specified, validates all trays in the Site. Use rackId/rackName to scope to a specific rack, and name/manufacturer/type to filter by tray attributes. @Tags tray @Accept json @Produce json @Security ApiKeyAuth @Param org path string true "Name of NGC organization" @Param siteId query string true "ID of the Site" @Param rackId query string false "Scope to a specific Rack by ID (mutually exclusive with rackName)" @Param rackName query string false "Scope to a specific Rack by name (mutually exclusive with rackId)" @Param name query string false "Filter trays by name" @Param manufacturer query string false "Filter trays by manufacturer" @Param type query string false "Filter trays by type (Compute, NVSwitch, PowerShelf)" @Param id query string false "Filter by component ID (mutually exclusive with rackId/rackName; use repeated params for multiple values)" @Param slotId query int false "Validate only trays at this rack slot (position.slotId). Requires rackId or rackName. Composes via AND." @Success 200 {object} model.APIRackValidationResult @Router /v2/org/{org}/nico/tray/validation [get]
Source Files
¶
- allocation.go
- allocationconstraint.go
- audit_entry.go
- bmccredential.go
- bmcreset.go
- credentialrotation.go
- dpuextensionservice.go
- dpumachine.go
- dpureprovision.go
- expectedinventorybatch.go
- expectedmachine.go
- expectedpowershelf.go
- expectedrack.go
- expectedrackgroup.go
- expectedswitch.go
- exploredendpoint.go
- fabric.go
- factoryreset.go
- firmware.go
- health.go
- hostfirmwareconfig.go
- infinibandinterface.go
- infinibandpartition.go
- infrastructureprovider.go
- instance.go
- instancebatch.go
- instancetype.go
- interface.go
- ipblock.go
- ipxetemplate.go
- labeldiscovery.go
- machine.go
- machinecapability.go
- machinehealth.go
- machineinstancetype.go
- machinepower.go
- machinespectrumxmultiplane.go
- machinevalidation.go
- measuredboot.go
- metadata.go
- networksecuritygroup.go
- nvlinkdomain.go
- nvlinkinterface.go
- nvlinklogicalpartition.go
- operatingsystem.go
- rack.go
- rackhealth.go
- rackpowerstate.go
- serviceaccount.go
- site.go
- siteexplorerendpointaction.go
- sku.go
- sku_compat.go
- spectrumxpartition.go
- sshkey.go
- sshkeygroup.go
- stats.go
- statusdetail.go
- subnet.go
- task.go
- taskrule.go
- taskrun.go
- tenant.go
- tenantaccount.go
- tenantidentity.go
- tray.go
- traydecommission.go
- trayhealth.go
- traypowerstate.go
- ueficredential.go
- user.go
- vpc.go
- vpcpeering.go
- vpcprefix.go
- vpcroutingprofile.go