Type Alias GetLinodeInterfaceResponses

Type Declaration

• {
      created: string;
      default_route: { ipv4: boolean; ipv6: boolean } | null;
      id: number;
      mac_address: string;
      public: {
          ipv4: {
              addresses: { address: string; primary: boolean }[];
              shared: { address: string; linode_id: string }[];
          };
          ipv6: {
              ranges: { range: string; route_target: string }[];
              shared: { range: string; route_target: string }[];
              slaac: { address: string; prefix: number }[];
          };
      };
      updated: string;
      version: number;
      vlan: { [key: string]: unknown }
      | null;
      vpc: { [key: string]: never } | null;
  }

  • created: string

    When the interface was created.

  • default_route: { ipv4: boolean; ipv6: boolean } | null

    Indicates if the interface is used as a default route.

  • Readonlyid: number

    Read-only The unique ID for this interface. For dry_run upgrades, a unique id is not generated for the interface and its value is set to 0.

  • mac_address: string

    A 48-bit MAC address used to identify the Linode’s interface. A public interface's mac_address does not change, even if the public interface is deleted and then recreated.

  • public: {
        ipv4: {
            addresses: { address: string; primary: boolean }[];
            shared: { address: string; linode_id: string }[];
        };
        ipv6: {
            ranges: { range: string; route_target: string }[];
            shared: { range: string; route_target: string }[];
            slaac: { address: string; prefix: number }[];
        };
    }

    Public interface type.

    • ipv4: {
          addresses: { address: string; primary: boolean }[];
          shared: { address: string; linode_id: string }[];
      }

      The interface's public IPv4 addresses.

      • addresses: { address: string; primary: boolean }[]

        The public IPv4 addresses and primary settings for this public interface.

      • shared: { address: string; linode_id: string }[]

        The IPv4 address assigned to this Linode interface, which is also shared with another Linode.

    • ipv6: {
          ranges: { range: string; route_target: string }[];
          shared: { range: string; route_target: string }[];
          slaac: { address: string; prefix: number }[];
      }

      The interface's public IPv6 configuration.

      • ranges: { range: string; route_target: string }[]

        List of IPv6 ranges assigned to this interface.

      • shared: { range: string; route_target: string }[]

        The IPv6 address assigned to this Linode interface, which is also shared with another Linode.

      • slaac: { address: string; prefix: number }[]

        The public slaac and subnet prefix settings for this public interface that is used to communicate over the public internet, and with other services in the same data center.

  • updated: string

    When the interface was last updated.

  • version: number

    Interface version number that increments when the interface updates.

  • vlan: { [key: string]: unknown } | null

    The value is null if this is not a VLAN interface.

  • vpc: { [key: string]: never } | null

    The value is null if this is not a VPC interface.

• {
      created: string;
      id: number;
      mac_address: string;
      public: { [key: string]: unknown } | null;
      updated: string;
      version: number;
      vlan: { ipam_address: string | null; vlan_label: string };
      vpc: { [key: string]: unknown } | null;
  }

  • created: string

    When the interface was created.

  • Readonlyid: number

    Read-only The unique ID for this interface. For dry_run upgrades, a unique id is not generated for the interface and its value is set to 0.

  • mac_address: string

    A 48-bit MAC address used to identify the Linode’s interface. The mac_address of an interface remains constant and does not change.

  • public: { [key: string]: unknown } | null

    The value is null if this isn't a public interface.

  • updated: string

    When the interface was last updated.

  • version: number

    Interface version number that is incremented when the interface is updated.

  • vlan: { ipam_address: string | null; vlan_label: string }

    VLAN interface type.

    • ipam_address: string | null

      This VLAN interface's private IPv4 address in classless inter-domain routing (CIDR) notation.

    • vlan_label: string

      The VLAN's label. VLAN interfaces on the same Linode must have a unique vlan_label.

  • vpc: { [key: string]: unknown } | null

    The value is null if this isn't a VPC interface.

• {
      created: string;
      default_route: { ipv4: boolean };
      id: number;
      mac_address: string;
      public: { [key: string]: never } | null;
      updated: string;
      version: number;
      vlan: { [key: string]: never } | null;
      vpc: {
          ipv4: {
              addresses: {
                  address: string;
                  nat_1_1_address: string | null;
                  primary: boolean;
              }[];
              ranges: { range: string }[];
          };
          subnet_id: number;
          vpc_id: number;
      };
  }

  • created: string

    When the interface was created.

  • default_route: { ipv4: boolean }

    Indicates if the interface serves as a default route.

    • ipv4: boolean

      Indicates if the interface serves as the IPv4 default route. Only one interface per Linode can have the IPv4 default route.

  • Readonlyid: number

    Read-only The unique ID for this interface. For dry_run upgrades, a unique id is not generated for the interface and its value is set to 0.

  • mac_address: string

    A 48-bit MAC address used to identify the Linode’s interface. The mac_address of an interface remains constant and does not change.

  • public: { [key: string]: never } | null

    The value is null if this is not a public interface.

  • updated: string

    When the interface last updated.

  • version: number

    The version number of the interface configuration, incremented each time the interface is updated.

  • vlan: { [key: string]: never } | null

    The value is null if this is not a VLAN interface.

  • vpc: {
        ipv4: {
            addresses: {
                address: string;
                nat_1_1_address: string | null;
                primary: boolean;
            }[];
            ranges: { range: string }[];
        };
        subnet_id: number;
        vpc_id: number;
    }

    VPC interface type.

    • ipv4: {
          addresses: {
              address: string;
              nat_1_1_address: string | null;
              primary: boolean;
          }[];
          ranges: { range: string }[];
      }

      The interface's IPv4 addresses and ranges configuration.

      • addresses: { address: string; nat_1_1_address: string | null; primary: boolean }[]

        IPv4 address settings for this VPC interface.

      • ranges: { range: string }[]

        VPC IPv4 ranges.

    • subnet_id: number

      VPC subnet's unique identifier.

    • vpc_id: number

      VPC's unique identifier.