feat: make oob_ip available regardless of oob_ip_as_primary_ip

[akire0ne]

Related Issue

Related to #1081

New Behavior

Makes oob_ip always available in the hostvars if it exists.

Discussion: Benefits and Drawbacks

Not sure why we make oob_ip available only when oob_ip_as_primary_ip is set.

I believe there is value to access this property without altering ansible_host.

Changes to the Documentation

None

Proposed Release Note Entry

• oob_ip is now returned in hostvars if set
• Add the ability to set out of band IP as ansible host.

Double Check

• I have read the comments and followed the CONTRIBUTING.md.
• I have explained my PR according to the information in the comments or in a linked issue.
• My PR targets the devel branch.

[sc68cal]

@Shourai can you please take a look, since you implemented the original feature?

[Shourai]

I have checked it out and tested it.
It's a really nice solution.

• With oob_ip_as_primary_ip: false and oob_ip defined but primary ip undefined, the variable oob_ip will be available but ansible_host will not be.

• With oob_ip_as_primary_ip: true and oob_ip defined but primary ip undefined, the variable oob_ip will be available and ansible_host will also be available.

It's useful if you have oob_ip defined and want to use that variable but not overwrite the primary_ip as ansible_host.

I had not thought about it since in our use-case we don't use the primary_ip and only use oob_ip for our devices.

Out of curiosity, @akire0ne, what use-cases do you have for the oob_ip variable?

[sc68cal]

That is a large matrix of behaviors. I don't know if I am a fan of this change.

[sc68cal]

Frankly I would rather have one configuration setting, where you either use the primary_ip of a device, or the oob_ip of a device for setting ansible_host, and leave it at that.

[sc68cal]

Creates too complex behaviors

[akire0ne]

Folks, two different things here

• Out-of-band IP is displayed on the Device UI in the same manner as Primary IPv4 and Primary IPv6 - So for me I would expect to be displayed in my hostvars as oob_ip , in the same fashion as primary_ip4 and primary_ip6are.
• Ability to set oob_ip as a ansible_host - We don't have that need, but as @Shourai already implemented something with oob_ip so I didn't wanted to clash with this.

Whatever works for me as long oob_ip is available when set on the device.

@sc68cal are you suggesting something like an ansible_host_ip_source setting, which could be set to either primary_ip4 (default) or oob_ip ? Frankly i'm missing the "too complex" behavior here.

FYI our business case is to be able to fetch / identify OOBM / IPMI easily for our devices.

[sc68cal]

OK. It took me a couple reads through your comments @akire0ne and @Shourai, because for some reason my brain was just not working properly and I was getting confused.

It was not because of anything you wrote, but for some reason it just didn't stick with me for some reason.

It's sad because the code is quite clear what is going on but I just wasn't getting it. Sorry.

This is good to go, thank you for the contribution and your patience, I will try and do better next time.

[akire0ne]

Thanks @sc68cal ! Very appreciated