{
    "id":"/axapi/v3/interface/ve/{ifnum}/ip",
    "type":"object",
    "node-type":"scalar",
    "title":"ip",
    "partition-visibility":"shared",
    "description":"Global IP configuration subcommands",
    "properties":{
        "dhcp":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Use DHCP to configure IP address",
            "optional":true
        },
        "address-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object"
            },
            "uniqueItems":true,
            "array":[
                {
                    "properties":{
                        "ipv4-address":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "description":"IP address"
                        },
                        "ipv4-netmask":{
                            "type":"string",
                            "format":"ipv4-netmask",
                            "partition-visibility":"shared",
                            "description":"IP subnet mask"
                        }
                    }
                }
            ]
        },
        "allow-promiscuous-vip":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Allow traffic to be associated with promiscuous VIP",
            "optional":true
        },
        "client":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Client facing interface for IPv4/v6 traffic",
            "optional":true
        },
        "server":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Server facing interface for IPv4/v6 traffic",
            "optional":true
        },
        "helper-address-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object"
            },
            "uniqueItems":true,
            "array":[
                {
                    "properties":{
                        "helper-address":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "description":"Helper address for DHCP packets (IP address)"
                        }
                    }
                }
            ]
        },
        "inside":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Configure interface as inside",
            "optional":true
        },
        "outside":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Configure interface as outside",
            "optional":true
        },
        "ttl-ignore":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Ignore TTL decrement for a received packet",
            "optional":true
        },
        "syn-cookie":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Enable SYN-cookie on the interface",
            "optional":true
        },
        "slb-partition-redirect":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Redirect SLB traffic across partition",
            "optional":true
        },
        "generate-membership-query":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Enable Membership Query",
            "optional":true
        },
        "query-interval":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":255,
            "default":125,
            "partition-visibility":"shared",
            "description":"1 - 255 (Default is 125)",
            "optional":true
        },
        "max-resp-time":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":255,
            "default":100,
            "partition-visibility":"shared",
            "description":"Maximum Response Time (Max Response Time (Default is 100))",
            "optional":true
        },
        "unnumbered":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Set the interface as unnumbered",
            "optional":true
        },
        "uuid":{
            "type":"string",
            "format":"string",
            "minLength":1,
            "maxLength":64,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"uuid of the object",
            "optional":true
        },
        "stateful-firewall":{
            "type":"object",
            "$ref":"/axapi/v3/interface/ve/{ifnum}/ip/stateful-firewall",
            "properties":{
                "inside":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Inside (private) interface for stateful firewall"
                },
                "class-list":{
                    "type":"string",
                    "format":"string-rlx",
                    "minLength":1,
                    "maxLength":63,
                    "partition-visibility":"shared",
                    "description":"Class List (Class List Name)"
                },
                "outside":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Outside (public) interface for stateful firewall"
                },
                "access-list":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Access-list for traffic from the outside"
                },
                "acl-id":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":199,
                    "partition-visibility":"shared",
                    "description":"ACL id"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "router":{
            "type":"object",
            "$ref":"/axapi/v3/interface/ve/{ifnum}/ip/router",
            "properties":{
                "isis":{
                    "type":"object",
                    "$ref":"/axapi/v3/interface/ve/{ifnum}/ip/router/isis",
                    "properties":{
                        "tag":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":128,
                            "partition-visibility":"shared",
                            "description":"ISO routing area tag"
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                }
            }
        },
        "rip":{
            "type":"object",
            "$ref":"/axapi/v3/interface/ve/{ifnum}/ip/rip",
            "properties":{
                "authentication":{
                    "type":"object",
                    "properties":{
                        "str":{
                            "type":"object",
                            "properties":{
                                "string":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":16,
                                    "partition-visibility":"shared",
                                    "description":"The RIP authentication string"
                                }
                            }
                        },
                        "mode":{
                            "type":"object",
                            "properties":{
                                "mode":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"text",
                                    "partition-visibility":"shared",
                                    "description":"'md5': Keyed message digest; 'text': Clear text authentication; ",
                                    "enum":[
                                        "md5",
                                        "text"
                                    ]
                                }
                            }
                        },
                        "key-chain":{
                            "type":"object",
                            "properties":{
                                "key-chain":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "partition-visibility":"shared",
                                    "description":"Authentication key-chain (Name of key-chain)"
                                }
                            }
                        }
                    }
                },
                "send-packet":{
                    "type":"number",
                    "format":"flag",
                    "default":1,
                    "partition-visibility":"shared",
                    "description":"Enable sending packets through the specified interface"
                },
                "receive-packet":{
                    "type":"number",
                    "format":"flag",
                    "default":1,
                    "partition-visibility":"shared",
                    "description":"Enable receiving packet through the specified interface"
                },
                "send-cfg":{
                    "type":"object",
                    "properties":{
                        "send":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Advertisement transmission"
                        },
                        "version":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'1': RIP version 1; '2': RIP version 2; '1-compatible': RIPv1-compatible; '1-2': RIP version 1 & 2; ",
                            "enum":[
                                "1",
                                "2",
                                "1-compatible",
                                "1-2"
                            ]
                        }
                    }
                },
                "receive-cfg":{
                    "type":"object",
                    "properties":{
                        "receive":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Advertisement reception"
                        },
                        "version":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'1': RIP version 1; '2': RIP version 2; '1-2': RIP version 1 & 2; ",
                            "enum":[
                                "1",
                                "2",
                                "1-2"
                            ]
                        }
                    }
                },
                "split-horizon-cfg":{
                    "type":"object",
                    "properties":{
                        "state":{
                            "type":"string",
                            "format":"enum",
                            "default":"poisoned",
                            "partition-visibility":"shared",
                            "description":"'poisoned': Perform split horizon with poisoned reverse; 'disable': Disable split horizon; 'enable': Perform split horizon without poisoned reverse; ",
                            "enum":[
                                "poisoned",
                                "disable",
                                "enable"
                            ]
                        }
                    }
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "ospf":{
            "type":"object",
            "$ref":"/axapi/v3/interface/ve/{ifnum}/ip/ospf",
            "properties":{
                "ospf-global":{
                    "type":"object",
                    "$ref":"/axapi/v3/interface/ve/{ifnum}/ip/ospf/ospf-global",
                    "properties":{
                        "authentication-cfg":{
                            "type":"object",
                            "properties":{
                                "authentication":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Enable authentication"
                                },
                                "value":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'message-digest': Use message-digest authentication; 'null': Use no authentication; ",
                                    "enum":[
                                        "message-digest",
                                        "null"
                                    ]
                                }
                            }
                        },
                        "authentication-key":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":8,
                            "partition-visibility":"shared",
                            "description":"Authentication password (key) (The OSPF password (key))"
                        },
                        "bfd-cfg":{
                            "type":"object",
                            "properties":{
                                "bfd":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Bidirectional Forwarding Detection (BFD)"
                                },
                                "disable":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Disable BFD"
                                }
                            }
                        },
                        "cost":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"Interface cost"
                        },
                        "database-filter-cfg":{
                            "type":"object",
                            "properties":{
                                "database-filter":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'all': Filter all LSA; ",
                                    "enum":[
                                        "all"
                                    ]
                                },
                                "out":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Outgoing LSA"
                                }
                            }
                        },
                        "dead-interval":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "default":40,
                            "partition-visibility":"shared",
                            "description":"Interval after which a neighbor is declared dead (Seconds)"
                        },
                        "disable":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'all': All functionality; ",
                            "enum":[
                                "all"
                            ]
                        },
                        "hello-interval":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "default":10,
                            "partition-visibility":"shared",
                            "description":"Time between HELLO packets (Seconds)"
                        },
                        "message-digest-cfg":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"object"
                            },
                            "uniqueItems":true,
                            "array":[
                                {
                                    "properties":{
                                        "message-digest-key":{
                                            "type":"number",
                                            "format":"number",
                                            "plat-neg-list":["fips"],
                                            "minimum":1,
                                            "maximum":255,
                                            "partition-visibility":"shared",
                                            "description":"Message digest authentication password (key) (Key id)"
                                        },
                                        "md5":{
                                            "type":"object",
                                            "properties":{
                                                "md5-value":{
                                                    "type":"string",
                                                    "format":"password",
                                                    "minLength":1,
                                                    "maxLength":16,
                                                    "partition-visibility":"shared",
                                                    "description":"The OSPF password (1-16)"
                                                },
                                                "encrypted":{
                                                    "type":"encrypted",
                                                    "format":"encrypted",
                                                    "partition-visibility":"shared",
                                                    "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)"
                                                }
                                            }
                                        }
                                    }
                                }
                            ]
                        },
                        "mtu":{
                            "type":"number",
                            "format":"number",
                            "minimum":576,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"OSPF interface MTU (MTU size)"
                        },
                        "mtu-ignore":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Ignores the MTU in DBD packets"
                        },
                        "network":{
                            "type":"object",
                            "properties":{
                                "broadcast":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "not-list":[ "non-broadcast", "point-to-point", "point-to-multipoint" ],
                                    "description":"Specify OSPF broadcast multi-access network"
                                },
                                "non-broadcast":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "not-list":[ "broadcast", "point-to-point", "point-to-multipoint" ],
                                    "description":"Specify OSPF NBMA network"
                                },
                                "point-to-point":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "not-list":[ "broadcast", "non-broadcast", "point-to-multipoint" ],
                                    "description":"Specify OSPF point-to-point network"
                                },
                                "point-to-multipoint":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "not-list":[ "broadcast", "non-broadcast", "point-to-point" ],
                                    "description":"Specify OSPF point-to-multipoint network"
                                },
                                "p2mp-nbma":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Specify non-broadcast point-to-multipoint network"
                                }
                            }
                        },
                        "priority":{
                            "type":"number",
                            "format":"number",
                            "minimum":0,
                            "maximum":255,
                            "default":1,
                            "partition-visibility":"shared",
                            "description":"Router priority"
                        },
                        "retransmit-interval":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "default":5,
                            "partition-visibility":"shared",
                            "description":"Time between retransmitting lost link state advertisements (Seconds)"
                        },
                        "transmit-delay":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "default":1,
                            "partition-visibility":"shared",
                            "description":"Link state transmit delay (Seconds)"
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                },
                "ospf-ip-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"ospf-ip"
                    },
                    "uniqueItems":true,
                    "$ref":"/axapi/v3/interface/ve/{ifnum}/ip/ospf/ospf-ip/{ip-addr}",
                    "array":[
                        {
                            "properties":{
                                "ip-addr":{
                                    "type":"string",
                                    "format":"ipv4-address",
                                    "partition-visibility":"shared",
                                    "description":"Address of interface",
                                    "optional":false
                                },
                                "authentication":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Enable authentication",
                                    "optional":true
                                },
                                "value":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'message-digest': Use message-digest authentication; 'null': Use no authentication; ",
                                    "enum":[
                                        "message-digest",
                                        "null"
                                    ],
                                    "optional":true
                                },
                                "authentication-key":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":8,
                                    "partition-visibility":"shared",
                                    "description":"Authentication password (key) (The OSPF password (key))",
                                    "optional":true
                                },
                                "cost":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "partition-visibility":"shared",
                                    "description":"Interface cost",
                                    "optional":true
                                },
                                "database-filter":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'all': Filter all LSA; ",
                                    "enum":[
                                        "all"
                                    ],
                                    "optional":true
                                },
                                "out":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Outgoing LSA",
                                    "optional":true
                                },
                                "dead-interval":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":40,
                                    "partition-visibility":"shared",
                                    "description":"Interval after which a neighbor is declared dead (Seconds)",
                                    "optional":true
                                },
                                "hello-interval":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":10,
                                    "partition-visibility":"shared",
                                    "description":"Time between HELLO packets (Seconds)",
                                    "optional":true
                                },
                                "message-digest-cfg":{
                                    "type":"array",
                                    "minItems":1,
                                    "items":{
                                        "type":"object"
                                    },
                                    "uniqueItems":true,
                                    "array":[
                                        {
                                            "properties":{
                                                "message-digest-key":{
                                                    "type":"number",
                                                    "format":"number",
                                                    "plat-neg-list":["fips"],
                                                    "minimum":1,
                                                    "maximum":255,
                                                    "partition-visibility":"shared",
                                                    "description":"Message digest authentication password (key) (Key id)"
                                                },
                                                "md5-value":{
                                                    "type":"string",
                                                    "format":"password",
                                                    "minLength":1,
                                                    "maxLength":16,
                                                    "partition-visibility":"shared",
                                                    "description":"The OSPF password (1-16)"
                                                },
                                                "encrypted":{
                                                    "type":"encrypted",
                                                    "format":"encrypted",
                                                    "partition-visibility":"shared",
                                                    "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)"
                                                }
                                            }
                                        }
                                    ]
                                },
                                "mtu-ignore":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Ignores the MTU in DBD packets",
                                    "optional":true
                                },
                                "priority":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":0,
                                    "maximum":255,
                                    "default":1,
                                    "partition-visibility":"shared",
                                    "description":"Router priority",
                                    "optional":true
                                },
                                "retransmit-interval":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":5,
                                    "partition-visibility":"shared",
                                    "description":"Time between retransmitting lost link state advertisements (Seconds)",
                                    "optional":true
                                },
                                "transmit-delay":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":1,
                                    "partition-visibility":"shared",
                                    "description":"Link state transmit delay (Seconds)",
                                    "optional":true
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                }
                            },
                            "required":[
                                "ip-addr"
                            ]
                        }
                    ]
                }
            }
        }
    }
}