Skip to content

CampusGateway (Batch)

ActionBatchCampusGateway

ActionBatchCampusGateway class.

create_network_campus_gateway_cluster

Create a cluster and add campus gateways to it.

API documentation: createNetworkCampusGatewayCluster

Parameters:

  • network_id (str) –

    Network ID.

  • name (str) –

    Name of the new cluster.

  • uplinks (list[CreateNetworkCampusGatewayClusterUplinksItem]) –

    Uplink interface settings of the cluster.

  • tunnels (list[CreateNetworkCampusGatewayClusterTunnelsItem]) –

    Tunnel interface settings of the cluster: Reuse uplink or specify tunnel interface.

  • nameservers (CreateNetworkCampusGatewayClusterNameservers) –

    Nameservers of the cluster.

  • port_channels (list[CreateNetworkCampusGatewayClusterPortChannelsItem]) –

    Port channel settings of the cluster.

  • devices (list[CreateNetworkCampusGatewayClusterDevicesItem] | None, default: None ) –

    Devices to be added to the cluster.

  • notes (str | None, default: None ) –

    Notes about cluster with max size of 511 characters allowed.

update_network_campus_gateway_cluster

Update a cluster and add/remove campus gateways to/from it.

API documentation: updateNetworkCampusGatewayCluster

Parameters:

  • network_id (str) –

    Network ID.

  • cluster_id (str) –

    Cluster ID.

  • name (str | None, default: None ) –

    Name of the cluster.

  • uplinks (list[UpdateNetworkCampusGatewayClusterUplinksItem] | None, default: None ) –

    Uplink interface settings of the cluster.

  • tunnels (list[UpdateNetworkCampusGatewayClusterTunnelsItem] | None, default: None ) –

    Tunnel interface settings of the cluster: Reuse uplink or specify tunnel interface.

  • nameservers (UpdateNetworkCampusGatewayClusterNameservers | None, default: None ) –

    Nameservers of the cluster.

  • port_channels (list[UpdateNetworkCampusGatewayClusterPortChannelsItem] | None, default: None ) –

    Port channel settings of the cluster.

  • devices (list[UpdateNetworkCampusGatewayClusterDevicesItem] | None, default: None ) –

    Devices in the cluster.

  • notes (str | None, default: None ) –

    Notes about cluster with max size of 511 characters allowed.