Ir al contenido

network

El dominio network tiene 9 acciones. En la superficie meta se alcanzan todas a través de arcane_network; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

AcciónTítuloTipo
network.connect_containerConnect container to networkescritura
network.countsNetwork countslectura
network.createCreate networkescritura
network.deleteDelete networkdestructiva
network.disconnect_containerDisconnect container from networkescritura
network.getGet networklectura
network.listList networkslectura
network.prunePrune networksdestructiva
network.topologyGet network topologylectura

Connect container to network

  • Tipo: escritura
  • Parámetros obligatorios: networkId, containerId
  • Meta-herramienta: arcane_network con "action": "connect_container"
  • Herramienta individual: arcane_network_connect_container
  • Ruta de Arcane: POST /api/environments/{id}/networks/{networkId}/connect
  • ID de operación: connect-network-container
  • Uso: Attaches an existing container, running or stopped, to a network without recreating it. networkId from network.list or network.create, containerId (ID or name) from container.list. aliases adds network-scoped DNS names. ipv4Address/ipv6Address request a static address, which Docker allows only on a user-defined network with a configured subnet (a malformed address gives 400). Verify with network.get containersList or container.get.
  • Acciones relacionadas: container.list, network.get, network.disconnect_container

Network counts

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_network con "action": "counts"
  • Herramienta individual: arcane_network_counts
  • Ruta de Arcane: GET /api/environments/{id}/networks/counts
  • ID de operación: network-counts
  • Uso: Returns inuse, unused and total for the environment’s networks, a cheap overview before network.prune. total counts every network, but inuse and unused count only non-default networks (default ones such as bridge, host and none are skipped), so they need not add up to total. Use network.list for the networks themselves.
  • Acciones relacionadas: network.list, network.prune

Create network

  • Tipo: escritura
  • Parámetros obligatorios: name, options
  • Meta-herramienta: arcane_network con "action": "create"
  • Herramienta individual: arcane_network_create
  • Ruta de Arcane: POST /api/environments/{id}/networks
  • ID de operación: create-network
  • Uso: name and options are both required (options may be {}): driver (Docker uses bridge when empty, and overlay needs a Swarm manager), labels, internal (no outside access), attachable, enableIPv6, options (driver options) and ipam {driver, config: [{subnet, gateway, ipRange}]} for fixed subnets. Returns the new network id (and Docker’s warning, if any) for network.connect_container or network.get.
  • Acciones relacionadas: network.list, network.connect_container, network.get

Delete network

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: networkId
  • Meta-herramienta: arcane_network con "action": "delete"
  • Herramienta individual: arcane_network_delete
  • Ruta de Arcane: DELETE /api/environments/{id}/networks/{networkId}
  • ID de operación: delete-network
  • Uso: Removes one network. networkId takes the ID or name from network.list. Docker refuses while containers are still connected (disconnect them with network.disconnect_container first) and never removes the default bridge, host or none networks. Use network.prune to remove every unused network at once.
  • Acciones relacionadas: network.list, network.disconnect_container, network.prune

Disconnect container from network

  • Tipo: escritura
  • Parámetros obligatorios: networkId, containerId
  • Meta-herramienta: arcane_network con "action": "disconnect_container"
  • Herramienta individual: arcane_network_disconnect_container
  • Ruta de Arcane: POST /api/environments/{id}/networks/{networkId}/disconnect
  • ID de operación: disconnect-network-container
  • Uso: Detaches a container from a network without recreating it. networkId from network.list, containerId (ID or name) from container.list or the network’s containersList in network.get. force=true forces the disconnect. Check the result with network.get or container.get.
  • Acciones relacionadas: network.get, network.connect_container, container.get

Get network

  • Tipo: lectura
  • Parámetros obligatorios: networkId
  • Meta-herramienta: arcane_network con "action": "get"
  • Herramienta individual: arcane_network_get
  • Ruta de Arcane: GET /api/environments/{id}/networks/{networkId}
  • ID de operación: get-network
  • Uso: Inspects one network. networkId takes the ID or name from network.list, and an unknown network gives 404. Returns driver, scope, ipam (subnets, gateways), options, labels, internal, attachable, enableIPv6 and containersList, one entry per connected container with id, name, ipv4Address, ipv6Address and macAddress, sorted by name or with sort=ip by address (order asc or desc).
  • Acciones relacionadas: network.list, network.topology, network.connect_container

List networks

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_network con "action": "list"
  • Herramienta individual: arcane_network_list
  • Ruta de Arcane: GET /api/environments/{id}/networks
  • ID de operación: list-networks
  • Uso: Pages through the environment’s Docker networks (start, limit, default 20). search matches name, driver, scope, ID, subnet and gateway, sort takes name, driver, scope, created, inUse, subnet or gateway. inUse=true keeps networks a container uses plus Docker’s default networks, inUse=false the unused non-default ones. Each item gives id, name, driver, scope, ipam, labels, inUse and isDefault. The response counts always cover every network, ignoring search and inUse, and treat default networks as in use.
  • Acciones relacionadas: network.get, network.counts, network.topology, network.create

Prune networks

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_network con "action": "prune"
  • Herramienta individual: arcane_network_prune
  • Ruta de Arcane: POST /api/environments/{id}/networks/prune
  • ID de operación: prune-networks
  • Uso: Deletes every network no container is connected to (Docker keeps its default bridge, host and none networks) and returns networksDeleted. Check what would go with network.counts or network.list inUse=false first, and use network.delete for a single network or system.prune_all to prune containers, images and volumes too.
  • Acciones relacionadas: network.counts, network.list, network.delete, system.prune_all

Get network topology

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_network con "action": "topology"
  • Herramienta individual: arcane_network_topology
  • Ruta de Arcane: GET /api/environments/{id}/networks/topology
  • ID de operación: get-network-topology
  • Uso: Takes no parameters and returns the environment’s network graph: nodes of type network (metadata driver, scope, isDefault) and container (metadata status, image), and edges from a network id (source) to a connected container id (target) with that container’s ipv4Address/ipv6Address. Only containers attached to some network appear. Use network.get for one network in detail.
  • Acciones relacionadas: network.list, network.get, container.get