kubectl-net

command module
v0.0.0-...-1ed25f8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

README

kubectl-net

A kubectl plugin for managing network-operator custom resources.

Installation

Install via go install:

go install github.com/ironcore-dev/network-operator/kubectl-net@latest

Ensure your $GOBIN (or default $GOPATH/bin) is on your $PATH.

Verify kubectl discovers the plugin:

kubectl plugin list | grep kubectl-net

You can now run the plugin as kubectl net.

Build from source
go build -o kubectl-net .
sudo install -m 0755 kubectl-net /usr/local/bin/kubectl-net
kubectl plugin list | grep kubectl-net

Usage

demo

Get resources

The get subcommand works like kubectl get and supports the same output flags (-o yaml, -o json, -o wide, -o name, -o jsonpath=..., etc.).

# List all devices (server-side table output, same as kubectl get)
kubectl net get devices

# Get a single device
kubectl net get devices leaf1

# Filter interfaces by device
kubectl net get interfaces --device leaf1

# Filter interfaces by VRF
kubectl net get interfaces --vrf default

# Filter interfaces by aggregate
kubectl net get interfaces --aggregate ae0

# Filter VLANs by EVPN instance
kubectl net get vlans --evi evi-100

# Filter VLANs by routed VLAN interface
kubectl net get vlans --routed-vlan irb100

# Output as YAML
kubectl net get devices leaf1 -o yaml
Pause and unpause resources

The pause and unpause subcommands set or remove the networking.metal.ironcore.dev/paused annotation. For devices, --recursive also sets spec.paused to propagate to child resources.

# Pause a single interface
kubectl net pause interfaces lo0

# Unpause interface
kubectl net unpause interfaces lo0

# Pause a device and all child resources
kubectl net pause devices leaf1 --recursive

# Unpause a device and all child resources
kubectl net unpause devices leaf1 --recursive

# Pause all interfaces on a device
kubectl net pause interfaces --device leaf1
Device maintenance

Maintenance commands annotate one Device and return after the request is accepted by the Kubernetes API. The controller performs the operation asynchronously.

kubectl net reboot leaf1
kubectl net factory-reset leaf1
kubectl net reprovision leaf1
kubectl net reset-phase leaf1
kubectl net skip-provisioning leaf1
kubectl net firmware-upgrade leaf1 \
  --url https://images.example.com/nxos.bin \
  --md5 0123456789abcdef

All commands require exactly one Device. Firmware upgrades require --url; --md5 is optional. Reboot, factory reset, reprovision, and firmware upgrade prompt for confirmation; use --yes in non-interactive workflows.

Shell completion
# Generate and source completion for your shell
source <(kubectl net completion bash)
source <(kubectl net completion zsh)
kubectl net completion fish | source

Label shorthand flags

Flag Label Available for
--device, -d networking.metal.ironcore.dev/device-name All resources
--aggregate networking.metal.ironcore.dev/aggregate Interfaces
--vrf networking.metal.ironcore.dev/vrf Interfaces
--routed-vlan networking.metal.ironcore.dev/routed-vlan VLANs
--evi networking.metal.ironcore.dev/l2vni VLANs

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
cmd
Package cmd implements the kubectl-net plugin commands for managing network-operator resources.
Package cmd implements the kubectl-net plugin commands for managing network-operator resources.
tools
generate-resources command
generate-resources walks the network-operator API directory for *_types.go files and extracts resource definitions from kubebuilder markers:
generate-resources walks the network-operator API directory for *_types.go files and extracts resource definitions from kubebuilder markers:

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL