Configuration API - updateSocketInterface

The site ID isn't shown in the Cato Management Application, you can locate the site ID:

The socketInterfaceId is an enum which contains values for the Cato Sockets. The interface names are shown in the Sockets screen for a site (Network > Sites > {site name} > Site Configuration > Socket) as follows:

The destType is an enum argument, which defines the destination for the interface.

These are the options:

The name argument is for the name of the Socket interface.

The lan arguments are for the settings for a LAN interface for the Socket.

These are the options:

For interfaces that are used for WAN traffic, the bandwidth arguments define the upstream and downstream bandwidth for the interface.

These are the options:

The wan arguments are for the settings for a WAN interface for the Socket. The WAN roles are generally used for to define traffic in network rules. The precedence is used for failover precedence for a Socket with active and passive interfaces

These are the options:

The offCloud arguments are for Socket sites that use the Off-Cloud feature to route traffic over the public Internet instead of over the Cato Cloud.

These are the options:

The altWan arguments are for Socket sites that connect to an Alternative WAN network, such as MPLS. Generally, private IPs and interfaces are used for connecting directly to the MPLS provider.

These are the options:

The lag argument is for the master LAN LAG interface and defines the minimum number of interfaces (including master and member) for the LAG for this Socket site.

This is the option:

The vrrp enum argument is for Socket HA configurations and defines the type of VRRP connection between the Sockets for the keepalive messages.

These are the options:

This is an example of using the configuration API to change the name of the LAN1 interface to LAN-01, and update the subnet and localIP of the native range for Socket.

mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
    site(accountId: $accountId) {
        updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
            siteId
            socketInterfaceId
        }
    }
}

GraphQL Variables

{
    "accountId": "26",
    "siteId": 26,
    "socketInterfaceId": "LAN1",
    "input": {
        "name": "LAN-01",
        "destType": "LAN",
        "lan": {
            "subnet": "10.0.0.0/24",
            "localIp": "10.0.0.1"
        }
    }
}

This is an example of using configuration API to change the bandwidth and name for the WAN interface.

mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
    site(accountId: $accountId) {
        updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
            siteId
            socketInterfaceId
        }
    }
}

GraphQL Variables

{
    "accountId": "26",
    "siteId": 126,
    "socketInterfaceId": "WAN1",
    "input": {
        "name": "WAN Demo",
        "destType": "CATO",
        "bandwidth": {
            "upstreamBandwidth": 100,
            "downstreamBandwidth": 100
        }
    }
}