protocol

Description

A network protocol is a combination of one or more port numbers and the layer 4 protocol that is used (tcp, udp, or ip). The closest analogy to a venue concept is a layer 4 packet filter rule.

Required Properties

ports (list of dict)

A range of ports the protocol uses.

description (string)

A description of the port and why it exists.

name (string)

The name of this port.

port (port_range)

A port or range of ports

proto (string)

The IP network protocol type name.

Allowed Values:

• icmp

• ip

• tcp

• udp

The default value if not specified is tcp.

Optional Properties

description (string)

A description of the protocol and why it exists.

Common Properties

name (string)

The name of this protocol. The name can be different than the blueprint object name. When the name property is not present we apply automatic naming strategies to make resources easier to identify in each venue's management console. When the name property is specified we will use it exactly as specified.

readonly (boolean)

Indicates whether or not this protocol is read-only. If so, we verify only the existence and correctness of this protocol to its specification rather than creating or modifying it.

The default value if not specified is false.

Discovered Properties

These properties are populated and available in the inventory following a successful apply.

id (string)

The venue-specific identifier of this protocol.

Examples

Define a protocol for http:

networking:
  protocol:
    http:
      ports:
        - port: 80
          proto: tcp

Define a protocol for redis:

networking:
  protocol:
    redis:
      ports:
        - port: 22
          proto: tcp

Define a protocol for ssh:

networking:
  protocol:
    ssh:
      ports:
        - port: 6379
          proto: tcp

Define a protocol for various ports used by SQL Server:

networking:
  protocol:
    mssql:
      ports:
        - description: MSSQL
          port: 1433
          proto: tcp
        - description: MSSQL Discovery
          port: 1434
          proto: udp
        - description: MSSQL Management
          port: 1434
          proto: tcp