|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "iosxr_router_hsrp_interface_address_family_ipv4 Data Source - terraform-provider-iosxr" |
| 4 | +subcategory: "HSRP" |
| 5 | +description: |- |
| 6 | + This data source can read the Router HSRP Interface Address Family IPv4 configuration. |
| 7 | +--- |
| 8 | + |
| 9 | +# iosxr_router_hsrp_interface_address_family_ipv4 (Data Source) |
| 10 | + |
| 11 | +This data source can read the Router HSRP Interface Address Family IPv4 configuration. |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +data "iosxr_router_hsrp_interface_address_family_ipv4" "example" { |
| 17 | + interface_name = "GigabitEthernet0/0/0/1" |
| 18 | +} |
| 19 | +``` |
| 20 | + |
| 21 | +<!-- schema generated by tfplugindocs --> |
| 22 | +## Schema |
| 23 | + |
| 24 | +### Required |
| 25 | + |
| 26 | +- `interface_name` (String) HSRP interface configuration subcommands |
| 27 | + |
| 28 | +### Optional |
| 29 | + |
| 30 | +- `device` (String) A device name from the provider configuration. |
| 31 | + |
| 32 | +### Read-Only |
| 33 | + |
| 34 | +- `group_number_version_1s` (Attributes List) group number version 1 (see [below for nested schema](#nestedatt--group_number_version_1s)) |
| 35 | +- `group_number_version_2s` (Attributes List) group number version 2 (see [below for nested schema](#nestedatt--group_number_version_2s)) |
| 36 | +- `id` (String) The path of the retrieved object. |
| 37 | + |
| 38 | +<a id="nestedatt--group_number_version_1s"></a> |
| 39 | +### Nested Schema for `group_number_version_1s` |
| 40 | + |
| 41 | +Read-Only: |
| 42 | + |
| 43 | +- `address_ipv4_address` (String) Hot standby IP address |
| 44 | +- `address_learn` (Boolean) Learn virtual IP address from peer |
| 45 | +- `bfd_fast_detect_peer_interface` (String) Select an interface over which to run BFD |
| 46 | +- `bfd_fast_detect_peer_ipv4` (String) BFD peer interface IPv4 address |
| 47 | +- `group_number_version_1_id` (Number) group number version 1 |
| 48 | +- `mac_address` (String) Use specified mac address for the virtual router |
| 49 | +- `name` (String) MGO session name |
| 50 | +- `preempt_delay` (Number) Wait before preempting |
| 51 | +- `priority` (Number) Priority level |
| 52 | +- `secondary_ipv4_addresses` (Attributes List) Set secondary hot standby IP address (see [below for nested schema](#nestedatt--group_number_version_1s--secondary_ipv4_addresses)) |
| 53 | +- `timers_hold_time` (Number) Hold time in seconds |
| 54 | +- `timers_hold_time2` (Number) Hold time in seconds |
| 55 | +- `timers_msec` (Number) Specify hellotime in milliseconds |
| 56 | +- `timers_msec2` (Number) Specify hold time in milliseconds |
| 57 | +- `track_interfaces` (Attributes List) Configure tracking (see [below for nested schema](#nestedatt--group_number_version_1s--track_interfaces)) |
| 58 | +- `track_objects` (Attributes List) Object tracking (see [below for nested schema](#nestedatt--group_number_version_1s--track_objects)) |
| 59 | + |
| 60 | +<a id="nestedatt--group_number_version_1s--secondary_ipv4_addresses"></a> |
| 61 | +### Nested Schema for `group_number_version_1s.secondary_ipv4_addresses` |
| 62 | + |
| 63 | +Read-Only: |
| 64 | + |
| 65 | +- `address` (String) Set secondary hot standby IP address |
| 66 | + |
| 67 | + |
| 68 | +<a id="nestedatt--group_number_version_1s--track_interfaces"></a> |
| 69 | +### Nested Schema for `group_number_version_1s.track_interfaces` |
| 70 | + |
| 71 | +Read-Only: |
| 72 | + |
| 73 | +- `priority_decrement` (Number) Priority decrement |
| 74 | +- `track_name` (String) Configure tracking |
| 75 | + |
| 76 | + |
| 77 | +<a id="nestedatt--group_number_version_1s--track_objects"></a> |
| 78 | +### Nested Schema for `group_number_version_1s.track_objects` |
| 79 | + |
| 80 | +Read-Only: |
| 81 | + |
| 82 | +- `object_name` (String) Object tracking |
| 83 | +- `priority_decrement` (Number) Priority decrement |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | +<a id="nestedatt--group_number_version_2s"></a> |
| 88 | +### Nested Schema for `group_number_version_2s` |
| 89 | + |
| 90 | +Read-Only: |
| 91 | + |
| 92 | +- `address_ipv4_address` (String) Hot standby IP address |
| 93 | +- `address_learn` (Boolean) Learn virtual IP address from peer |
| 94 | +- `bfd_fast_detect_peer_interface` (String) Select an interface over which to run BFD |
| 95 | +- `bfd_fast_detect_peer_ipv4` (String) BFD peer interface IPv4 address |
| 96 | +- `group_number_version_2_id` (Number) group number version 2 |
| 97 | +- `mac_address` (String) Use specified mac address for the virtual router |
| 98 | +- `name` (String) MGO session name |
| 99 | +- `preempt_delay` (Number) Wait before preempting |
| 100 | +- `priority` (Number) Priority level |
| 101 | +- `secondary_ipv4_addresses` (Attributes List) Set secondary hot standby IP address (see [below for nested schema](#nestedatt--group_number_version_2s--secondary_ipv4_addresses)) |
| 102 | +- `timers_hold_time` (Number) Hold time in seconds |
| 103 | +- `timers_hold_time2` (Number) Hold time in seconds |
| 104 | +- `timers_msec` (Number) Specify hellotime in milliseconds |
| 105 | +- `timers_msec2` (Number) Specify hold time in milliseconds |
| 106 | +- `track_interfaces` (Attributes List) Configure tracking (see [below for nested schema](#nestedatt--group_number_version_2s--track_interfaces)) |
| 107 | +- `track_objects` (Attributes List) Object tracking (see [below for nested schema](#nestedatt--group_number_version_2s--track_objects)) |
| 108 | + |
| 109 | +<a id="nestedatt--group_number_version_2s--secondary_ipv4_addresses"></a> |
| 110 | +### Nested Schema for `group_number_version_2s.secondary_ipv4_addresses` |
| 111 | + |
| 112 | +Read-Only: |
| 113 | + |
| 114 | +- `address` (String) Set secondary hot standby IP address |
| 115 | + |
| 116 | + |
| 117 | +<a id="nestedatt--group_number_version_2s--track_interfaces"></a> |
| 118 | +### Nested Schema for `group_number_version_2s.track_interfaces` |
| 119 | + |
| 120 | +Read-Only: |
| 121 | + |
| 122 | +- `priority_decrement` (Number) Priority decrement |
| 123 | +- `track_name` (String) Configure tracking |
| 124 | + |
| 125 | + |
| 126 | +<a id="nestedatt--group_number_version_2s--track_objects"></a> |
| 127 | +### Nested Schema for `group_number_version_2s.track_objects` |
| 128 | + |
| 129 | +Read-Only: |
| 130 | + |
| 131 | +- `object_name` (String) Object tracking |
| 132 | +- `priority_decrement` (Number) Priority decrement |
0 commit comments