Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
MetalSoft 7.0 Documentation
Light Logo Dark Logo

The MetalSoft Platform

  • Getting started
    • Architecture
      • Network topology
      • User interfaces
    • Deploying MetalSoft
      • Deployment Overview
      • Physical topology
      • Kubernetes cluster compute requirements
      • Deploying the MetalSoft Global Controller
      • Deploying the MetalSoft Site Controller
      • Deploying MetalSoft in an air gapped environment
      • Setup of MetalSoft Kubernetes Cluster on K3S
      • Using the CLI
      • Registering switches via Zero Touch Provisioning (ZTP)
      • Registering servers via Zero Touch Provisioning (ZTP)
      • Deploying MetalSoft using OVAs
      • Enabling end-users to create custom RAID configurations
    • Troubleshooting and Maintenance
      • Event log archiving via Kafka
      • Managing custom ISO’s
      • Kubernetes cluster certificate management
    • How to backup MetalSoft
    • How to enable Disaster Recovery for MetalSoft
    • Release notes
  • Configuration
    • Users and permissions
      • Authentication Overview
      • Managing users and permissions
      • Configuring LDAP authentication for Microsoft Active Directory
      • Configure SAML for OKTA
      • Managing Resource Pools
      • Managing accounts
    • Sites
      • Adding a new site
    • Networking
      • Networking overview
      • Managing network devices
      • Switch replace
      • Managing switch pairs
      • IP address Management (IPAM)
      • Fabrics
      • Managing network profiles
      • Adding a new external connection
    • Servers
      • Servers overview
        • Server lifecycle
        • Managing hardware failures and changes
        • Server types
        • Adding a new server or endpoint
        • Adding a new managed server
        • Re-registering a server
        • Managing server firmware
        • Managing firmware catalogs
        • Managing Firmware baselines
      • Server lifecycle
      • Managing hardware failures and changes
      • Server types
      • Adding a new server or endpoint
      • Adding a new managed server
      • Managing BIOS settings
      • Re-registering a server
      • Adding a new Endpoint
      • Managing server firmware
      • Managing firmware catalogs
      • Managing Firmware baselines
    • Storage
      • Adding a new storage pool
      • Storage Appliances Prerequisites
      • Managing storage pools
    • Operating System Templates
      • Managing Operating System templates
      • Template language and variables
      • JSON Schema
      • How to add boot and install drivers to a repository Windows ISO
    • Resource Pools
      • Managing resource pools
    • Monitoring
      • Syslog forwarding and alerting
    • Virtualization
      • Managing VM Pools
      • Managing VMs
    • Metalsoft CLI Documentation
      • metalcloud-cli account
      • metalcloud-cli account archive
      • metalcloud-cli account create
      • metalcloud-cli account get
      • metalcloud-cli account list
      • metalcloud-cli account update
      • metalcloud-cli account users
      • metalcloud-cli bucket
      • metalcloud-cli bucket config-info
      • metalcloud-cli bucket create
      • metalcloud-cli bucket delete
      • metalcloud-cli bucket get
      • metalcloud-cli bucket get-credentials
      • metalcloud-cli bucket list
      • metalcloud-cli bucket update-config
      • metalcloud-cli bucket update-meta
      • metalcloud-cli custom-iso
      • metalcloud-cli custom-iso boot-server
      • metalcloud-cli custom-iso config-example
      • metalcloud-cli custom-iso create
      • metalcloud-cli custom-iso delete
      • metalcloud-cli custom-iso get
      • metalcloud-cli custom-iso list
      • metalcloud-cli custom-iso make-public
      • metalcloud-cli custom-iso update
      • metalcloud-cli drive
      • metalcloud-cli drive config-info
      • metalcloud-cli drive create
      • metalcloud-cli drive delete
      • metalcloud-cli drive get
      • metalcloud-cli drive get-hosts
      • metalcloud-cli drive list
      • metalcloud-cli drive update-config
      • metalcloud-cli drive update-hosts
      • metalcloud-cli drive update-meta
      • metalcloud-cli endpoint
      • metalcloud-cli endpoint create
      • metalcloud-cli endpoint delete
      • metalcloud-cli endpoint get
      • metalcloud-cli endpoint interfaces
      • metalcloud-cli endpoint list
      • metalcloud-cli endpoint update
      • metalcloud-cli event
      • metalcloud-cli event get
      • metalcloud-cli event list
      • metalcloud-cli extension
      • metalcloud-cli extension-instance
      • metalcloud-cli extension-instance create
      • metalcloud-cli extension-instance delete
      • metalcloud-cli extension-instance get
      • metalcloud-cli extension-instance list
      • metalcloud-cli extension-instance update
      • metalcloud-cli extension archive
      • metalcloud-cli extension create
      • metalcloud-cli extension get
      • metalcloud-cli extension list
      • metalcloud-cli extension publish
      • metalcloud-cli extension update
      • metalcloud-cli fabric
      • metalcloud-cli fabric activate
      • metalcloud-cli fabric add-device
      • metalcloud-cli fabric config-example
      • metalcloud-cli fabric create
      • metalcloud-cli fabric get
      • metalcloud-cli fabric get-devices
      • metalcloud-cli fabric list
      • metalcloud-cli fabric remove-device
      • metalcloud-cli fabric update
      • metalcloud-cli file-share
      • metalcloud-cli file-share config-info
      • metalcloud-cli file-share create
      • metalcloud-cli file-share delete
      • metalcloud-cli file-share get
      • metalcloud-cli file-share get-hosts
      • metalcloud-cli file-share list
      • metalcloud-cli file-share update-config
      • metalcloud-cli file-share update-hosts
      • metalcloud-cli file-share update-meta
      • metalcloud-cli firmware-baseline
      • metalcloud-cli firmware-baseline config-example
      • metalcloud-cli firmware-baseline create
      • metalcloud-cli firmware-baseline delete
      • metalcloud-cli firmware-baseline get
      • metalcloud-cli firmware-baseline list
      • metalcloud-cli firmware-baseline search
      • metalcloud-cli firmware-baseline search-example
      • metalcloud-cli firmware-baseline update
      • metalcloud-cli firmware-binary
      • metalcloud-cli firmware-binary config-example
      • metalcloud-cli firmware-binary create
      • metalcloud-cli firmware-binary delete
      • metalcloud-cli firmware-binary get
      • metalcloud-cli firmware-binary list
      • metalcloud-cli firmware-catalog
      • metalcloud-cli firmware-catalog create
      • metalcloud-cli firmware-catalog delete
      • metalcloud-cli firmware-catalog get
      • metalcloud-cli firmware-catalog list
      • metalcloud-cli firmware-catalog update
      • metalcloud-cli firmware-policy
      • metalcloud-cli firmware-policy apply-with-groups
      • metalcloud-cli firmware-policy apply-without-groups
      • metalcloud-cli firmware-policy config-example
      • metalcloud-cli firmware-policy create
      • metalcloud-cli firmware-policy delete
      • metalcloud-cli firmware-policy generate-audit
      • metalcloud-cli firmware-policy get
      • metalcloud-cli firmware-policy global-config
      • metalcloud-cli firmware-policy global-config config-example
      • metalcloud-cli firmware-policy global-config get
      • metalcloud-cli firmware-policy global-config update
      • metalcloud-cli firmware-policy list
      • metalcloud-cli firmware-policy update
      • metalcloud-cli infrastructure
      • metalcloud-cli infrastructure add-user
      • metalcloud-cli infrastructure all-statistics
      • metalcloud-cli infrastructure config-info
      • metalcloud-cli infrastructure create
      • metalcloud-cli infrastructure delete
      • metalcloud-cli infrastructure deploy
      • metalcloud-cli infrastructure get
      • metalcloud-cli infrastructure list
      • metalcloud-cli infrastructure remove-user
      • metalcloud-cli infrastructure revert
      • metalcloud-cli infrastructure statistics
      • metalcloud-cli infrastructure update
      • metalcloud-cli infrastructure user-limits
      • metalcloud-cli infrastructure users
      • metalcloud-cli infrastructure utilization
      • metalcloud-cli job
      • metalcloud-cli job-group
      • metalcloud-cli job-group get
      • metalcloud-cli job-group list
      • metalcloud-cli job get
      • metalcloud-cli job list
      • metalcloud-cli logical-network
      • metalcloud-cli logical-network-profile
      • metalcloud-cli logical-network-profile config-example
      • metalcloud-cli logical-network-profile create
      • metalcloud-cli logical-network-profile delete
      • metalcloud-cli logical-network-profile get
      • metalcloud-cli logical-network-profile list
      • metalcloud-cli logical-network-profile update
      • metalcloud-cli logical-network config-example
      • metalcloud-cli logical-network create
      • metalcloud-cli logical-network delete
      • metalcloud-cli logical-network get
      • metalcloud-cli logical-network list
      • metalcloud-cli logical-network update
      • metalcloud-cli network-device
      • metalcloud-cli network-device archive
      • metalcloud-cli network-device change-status
      • metalcloud-cli network-device config-example
      • metalcloud-cli network-device create
      • metalcloud-cli network-device delete
      • metalcloud-cli network-device discover
      • metalcloud-cli network-device enable-syslog
      • metalcloud-cli network-device get
      • metalcloud-cli network-device get-credentials
      • metalcloud-cli network-device get-defaults
      • metalcloud-cli network-device get-ports
      • metalcloud-cli network-device list
      • metalcloud-cli network-device reset
      • metalcloud-cli network-device set-port-status
      • metalcloud-cli network-device update
      • metalcloud-cli os-template
      • metalcloud-cli os-template create
      • metalcloud-cli os-template create-from-repo
      • metalcloud-cli os-template delete
      • metalcloud-cli os-template example-create
      • metalcloud-cli os-template get
      • metalcloud-cli os-template get-assets
      • metalcloud-cli os-template get-credentials
      • metalcloud-cli os-template list
      • metalcloud-cli os-template list-repo
      • metalcloud-cli os-template update
      • metalcloud-cli permission
      • metalcloud-cli permission list
      • metalcloud-cli resource-pool
      • metalcloud-cli resource-pool add-server
      • metalcloud-cli resource-pool add-subnet-pool
      • metalcloud-cli resource-pool add-user
      • metalcloud-cli resource-pool create
      • metalcloud-cli resource-pool delete
      • metalcloud-cli resource-pool get
      • metalcloud-cli resource-pool get-servers
      • metalcloud-cli resource-pool get-subnet-pools
      • metalcloud-cli resource-pool get-users
      • metalcloud-cli resource-pool list
      • metalcloud-cli resource-pool remove-server
      • metalcloud-cli resource-pool remove-subnet-pool
      • metalcloud-cli resource-pool remove-user
      • metalcloud-cli role
      • metalcloud-cli role create
      • metalcloud-cli role delete
      • metalcloud-cli role get
      • metalcloud-cli role list
      • metalcloud-cli role update
      • metalcloud-cli secret
      • metalcloud-cli secret config-example
      • metalcloud-cli secret create
      • metalcloud-cli secret delete
      • metalcloud-cli secret get
      • metalcloud-cli secret list
      • metalcloud-cli secret update
      • metalcloud-cli server
      • metalcloud-cli server-cleanup-policy
      • metalcloud-cli server-cleanup-policy get
      • metalcloud-cli server-cleanup-policy list
      • metalcloud-cli server-default-credentials
      • metalcloud-cli server-default-credentials create
      • metalcloud-cli server-default-credentials delete
      • metalcloud-cli server-default-credentials get
      • metalcloud-cli server-default-credentials get-credentials
      • metalcloud-cli server-default-credentials list
      • metalcloud-cli server-instance
      • metalcloud-cli server-instance-group
      • metalcloud-cli server-instance-group create
      • metalcloud-cli server-instance-group delete
      • metalcloud-cli server-instance-group get
      • metalcloud-cli server-instance-group instances
      • metalcloud-cli server-instance-group list
      • metalcloud-cli server-instance-group network
      • metalcloud-cli server-instance-group network connect
      • metalcloud-cli server-instance-group network disconnect
      • metalcloud-cli server-instance-group network get
      • metalcloud-cli server-instance-group network list
      • metalcloud-cli server-instance-group network update
      • metalcloud-cli server-instance-group update
      • metalcloud-cli server-instance get
      • metalcloud-cli server-type
      • metalcloud-cli server-type get
      • metalcloud-cli server-type list
      • metalcloud-cli server archive
      • metalcloud-cli server capabilities
      • metalcloud-cli server console-info
      • metalcloud-cli server delete
      • metalcloud-cli server enable-snmp
      • metalcloud-cli server enable-syslog
      • metalcloud-cli server factory-reset
      • metalcloud-cli server firmware
      • metalcloud-cli server firmware component-info
      • metalcloud-cli server firmware components
      • metalcloud-cli server firmware fetch-versions
      • metalcloud-cli server firmware generate-audit
      • metalcloud-cli server firmware inventory
      • metalcloud-cli server firmware schedule-upgrade
      • metalcloud-cli server firmware update-component
      • metalcloud-cli server firmware update-info
      • metalcloud-cli server firmware upgrade
      • metalcloud-cli server firmware upgrade-component
      • metalcloud-cli server get
      • metalcloud-cli server list
      • metalcloud-cli server power
      • metalcloud-cli server power-status
      • metalcloud-cli server re-register
      • metalcloud-cli server register
      • metalcloud-cli server update
      • metalcloud-cli server update-ipmi-credentials
      • metalcloud-cli server vnc-info
      • metalcloud-cli site
      • metalcloud-cli site agents
      • metalcloud-cli site create
      • metalcloud-cli site decommission
      • metalcloud-cli site get
      • metalcloud-cli site get-config
      • metalcloud-cli site list
      • metalcloud-cli site update
      • metalcloud-cli site update-config
      • metalcloud-cli storage
      • metalcloud-cli storage buckets
      • metalcloud-cli storage config-example
      • metalcloud-cli storage create
      • metalcloud-cli storage credentials
      • metalcloud-cli storage delete
      • metalcloud-cli storage drives
      • metalcloud-cli storage file-shares
      • metalcloud-cli storage get
      • metalcloud-cli storage list
      • metalcloud-cli storage network-configs
      • metalcloud-cli subnet
      • metalcloud-cli subnet config-example
      • metalcloud-cli subnet create
      • metalcloud-cli subnet delete
      • metalcloud-cli subnet get
      • metalcloud-cli subnet list
      • metalcloud-cli subnet update
      • metalcloud-cli template-asset
      • metalcloud-cli template-asset config-example
      • metalcloud-cli template-asset create
      • metalcloud-cli template-asset delete
      • metalcloud-cli template-asset get
      • metalcloud-cli template-asset list
      • metalcloud-cli template-asset update
      • metalcloud-cli user
      • metalcloud-cli user archive
      • metalcloud-cli user change-account
      • metalcloud-cli user config-update
      • metalcloud-cli user create
      • metalcloud-cli user create-bulk
      • metalcloud-cli user get
      • metalcloud-cli user limits
      • metalcloud-cli user limits-update
      • metalcloud-cli user list
      • metalcloud-cli user permissions
      • metalcloud-cli user permissions-update
      • metalcloud-cli user ssh-key-add
      • metalcloud-cli user ssh-key-delete
      • metalcloud-cli user ssh-keys
      • metalcloud-cli user suspend
      • metalcloud-cli user unarchive
      • metalcloud-cli user unsuspend
      • metalcloud-cli variable
      • metalcloud-cli variable config-example
      • metalcloud-cli variable create
      • metalcloud-cli variable delete
      • metalcloud-cli variable get
      • metalcloud-cli variable list
      • metalcloud-cli variable update
      • metalcloud-cli version
      • metalcloud-cli vm
      • metalcloud-cli vm-instance
      • metalcloud-cli vm-instance-group
      • metalcloud-cli vm-instance-group create
      • metalcloud-cli vm-instance-group delete
      • metalcloud-cli vm-instance-group get
      • metalcloud-cli vm-instance-group instances
      • metalcloud-cli vm-instance-group list
      • metalcloud-cli vm-instance-group update
      • metalcloud-cli vm-instance config
      • metalcloud-cli vm-instance get
      • metalcloud-cli vm-instance list
      • metalcloud-cli vm-instance power-status
      • metalcloud-cli vm-instance reboot
      • metalcloud-cli vm-instance shutdown
      • metalcloud-cli vm-instance start
      • metalcloud-cli vm-pool
      • metalcloud-cli vm-pool cluster-host-interfaces
      • metalcloud-cli vm-pool cluster-host-vms
      • metalcloud-cli vm-pool cluster-hosts
      • metalcloud-cli vm-pool config-example
      • metalcloud-cli vm-pool create
      • metalcloud-cli vm-pool credentials
      • metalcloud-cli vm-pool delete
      • metalcloud-cli vm-pool get
      • metalcloud-cli vm-pool list
      • metalcloud-cli vm-pool vms
      • metalcloud-cli vm-type
      • metalcloud-cli vm-type config-example
      • metalcloud-cli vm-type create
      • metalcloud-cli vm-type delete
      • metalcloud-cli vm-type get
      • metalcloud-cli vm-type list
      • metalcloud-cli vm-type update
      • metalcloud-cli vm-type vms
      • metalcloud-cli vm console-info
      • metalcloud-cli vm get
      • metalcloud-cli vm power-status
      • metalcloud-cli vm reboot
      • metalcloud-cli vm shutdown
      • metalcloud-cli vm start
      • metalcloud-cli vm update
  • ELI
    • ELI - AI assisted diagnosis overview
  • Operation
    • Getting started
    • Concepts
    • Managing infrastructures
    • Managing networks
    • Managing drive arrays
    • Deploying Kubernetes on MetalSoft
    • Using the CLI
    • Connecting to linux servers through SSH
    • Connecting to Windows servers through RDP
    • Delegating access to an infrastructure
    • Configuring a custom RAID profile
    • Enabling two factor authentication (2FA) in Metalcloud
    • Forcing specific servers at deploy
    • Adding ACL’s to a Server Instance Group or Endpoint Group
  • Developer resources
    • Developer Getting Started
    • Connecting to the API
    • Callbacks and post-install operations
    • Using the Terraform provider
    • Building a CI/CD pipeline
    • Integrating with a customer portal
    • Embedding the remote console
    • Integrating with a Billing System
    • Extensions
      • Extensions overview
      • App Extensions
      • Workflow extensions
    • Kafka Significant Events
    • Integrating MetalSoft with Hashicorp Vault

Fabric Manager

  • Fabric Manager
    • Fabric Manager Overview
    • Tutorials
      • Tutorial: Switch only operation with Dell Enterprise SONiC in GNS3
      • Tutorial - Dell Sonic Enterprise and Dell servers in a spine-leaf configuration
Back to top
View this page

Extensions¶

Since 7.0

Extensions are a way to attach arbitrary tasks to be executed by MetalSoft at specific events.

  • Extensions overview
    • Registering, unregistering and publishing an extension
    • Publishing an extensions
    • Archiving the extension
    • Extension types:
  • App Extensions
  • Workflow extensions
    • Example extension defition
    • More complex example
Next
Extensions overview
Previous
Integrating with a Billing System
Copyright © 2023, MetalSoft
Made with Sphinx and @pradyunsg's Furo