editPhysicalInterface

The editPhysicalInterface operation handles configuration related to PhysicalInterface model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name	False	string	An optional ASCII string, from 0 to 48 characters, representing the name of the interface. The string can only include lower case characters (a-z), numbers (0-9), underscore (_), dot (.), and plus/minus (+,-). The name can only start with an alpha numeric character.
description	False	string	An optional UTF-8 sting, from 0 to 200 characters. The string cannot include HTML tags, semi-colons(;), or carriage returns. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
hardwareName	False	string	A mandatory UTF-8 string for the PhysicalInterfaces and SubInterfaces, which normally specifies the type of Interface along with the Interface number. The string cannot contain HTML tags. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
monitorInterface	True	boolean	A mandatory boolean object which specifies if the Interface needs to be monitored or not. Field level constraints: cannot be null. (Note: Additional constraints might exist)
ipv4	False	object	An optional IPv4 object assigned to an interface in Firepower Device Manager. This object specifies Interface configuration for an IPv4 address.
ipv6	False	object	An optional IPv6 object assigned to an interface in Firepower Device Manager. This object specifies Interface configuration for an IPv6 address.
managementOnly	False	boolean	An optional Boolean value, TRUE or FALSE (default value). The TRUE value indicates that the interface is used for management only. FALSE indicates that interface is not used as a management purpose.
linkState	False	string	An enum value that specifies whether the Physical Interface link state is UP or DOWN (the default). Link state of an interface is the operational status/running status of the interface. The values can be one of the following. UP - Specifies whether the device is operationally UP. DOWN - Specifies whether the device is operationally DOWN.
mtu	True	integer	A mandatory Integer value, from 64 bytes to 9198 bytes, with a default value being set to 1500. Maximum Transfer Unit (MTU) is the size of the largest network layer protocol unit that can be communicated in a single network transaction. Field level constraints: cannot be null, must be between 64 and 9198 (inclusive). (Note: Additional constraints might exist)
enabled	True	boolean	A mandatory Boolean value, TRUE or FALSE (the default), specifies the administrative status of the Interface. The TRUE value enables the administrative status on the device. The value FALSE disables the administrative status on the device. Field level constraints: cannot be null. (Note: Additional constraints might exist)
macAddress	False	string	An optional String value, to specify a virtual MAC address. The MAC address must be in the format H.H.H where each H is a 16-bit hexadecimal number. For example, 000C.F142.4CDE Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
standbyMacAddress	False	string	An optional String value, to specify a virtual Standby MAC address. The MAC address must be in the format H.H.H where each H is a 16-bit hexadecimal number. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
speedType	False	string	An enum value that specifies the Interface Speed Type, where AUTO is the default .Values can be one of the following. AUTO - Enable auto-negotiation for this interface. TEN - Force 10 Mbps. HUNDRED - Force 100 Mbps. THOUSAND - Force 1 Gbps. TEN_THOUSAND - Force 10 Gbps. NO_NEGOTIATE - Do not negotiate speed. IGNORE - Do not configure Interface speed.
duplexType	False	string	An enum value that specifies the Interface Duplex Type, where AUTO is the default. Values can be one of the following . AUTO - Automatically selects either FULL or HALF duplex. HALF - Selects HALF duplex which enables only one way communication. FULL - Selects FULL duplex setting which enables both way communication at the same time. IGNORE - No duplex configuration needed.
mode	True	string	An enum value that specifies the physical interface mode where ROUTED is default. Values can be one of the following. ROUTED - Routed mode interfaces subject traffic to all firewall functions, including maintaining flows, tracking flow states at both IP and TCP layers, IP defragmentation, and TCP normalization, and your firewall policies. PASSIVE - Passive interfaces monitor traffic flowing across a network using a switch SPAN or mirror port. The SPAN or mirror port allows for traffic to be copied from other ports on the switch. This function provides the system visibility within the network without being in the flow of network traffic. When configured in a passive deployment, the system cannot take certain actions such as blocking or shaping traffic. Passive interfaces receive all traffic unconditionally and no traffic received on these interfaces is retransmitted. Field level constraints: cannot be null. (Note: Additional constraints might exist)
managementInterface	False	boolean	An optional Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the interface is a Management Interface. The value FALSE indicates that the interface is not a Management Interface.
tenGigabitInterface	False	boolean	An optional Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the interface is a Ten Gigabit Interface. The value FALSE indicates that the interface is not a Ten Gigabit Interface.
gigabitInterface	False	boolean	An optional Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the interface is a Gigabit Interface. The value FALSE indicates that the interface is not a Gigabit Interface.
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editPhysicalInterface' operation
  ftd_configuration:
    operation: "editPhysicalInterface"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        hardwareName: "{{ hardware_name }}"
        monitorInterface: "{{ monitor_interface }}"
        ipv4: "{{ ipv4 }}"
        ipv6: "{{ ipv6 }}"
        managementOnly: "{{ management_only }}"
        linkState: "{{ link_state }}"
        mtu: "{{ mtu }}"
        enabled: "{{ enabled }}"
        macAddress: "{{ mac_address }}"
        standbyMacAddress: "{{ standby_mac_address }}"
        speedType: "{{ speed_type }}"
        duplexType: "{{ duplex_type }}"
        mode: "{{ mode }}"
        managementInterface: "{{ management_interface }}"
        tenGigabitInterface: "{{ ten_gigabit_interface }}"
        gigabitInterface: "{{ gigabit_interface }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"