Ansible playbooks still use Traffic Ops API v1

[zrhoffman]

I'm submitting a ...

• improvement request (usability, performance, tech debt, etc.)

Traffic Control components affected ...

• Ansible playbooks

Current behavior:

The following references to the Traffic Ops API in our Ansible playbooks need to be updated:

HTTP Method	Endpoint	Line of Code
POST	api/1.3/user/login	trafficcontrol/infrastructure/ansible/influxdb_relay.yml Line 34 in df92555 url: "{{ to_url }}/api/1.3/user/login"
GET	api/1.3/servers	trafficcontrol/infrastructure/ansible/influxdb_relay.yml Line 49 in df92555 url: "{{ to_url }}/api/1.3/servers"
*	1.3	trafficcontrol/infrastructure/ansible/roles/dataset_loader/defaults/main.yml Line 25 in df92555 dl_to_api_version: 1.3
GET	internal/api/1.3/federations.json	trafficcontrol/infrastructure/ansible/roles/dataset_loader/defaults/main.yml Line 743 in df92555 value: https://${toHostname}/internal/api/1.3/federations.json
GET	api/1.3/profiles/name/{{name}}/parameters	trafficcontrol/infrastructure/ansible/roles/dataset_loader/profile.parameter.conversion.md Line 23 in df92555 3. Curl to get the response of https://{{ TO_BASE_URL }}/api/1.3/profiles/name/{{ TARGET_PROFILE }}/parameters and save that to a file named `profile.parameters.json`
POST	api/1.2/user/login	trafficcontrol/infrastructure/ansible/roles/to_api/tasks/login.yml Line 17 in df92555 url: "{{ to_api_base_url }}/api/1.2/user/login"
GET	api/1.2/cdns	trafficcontrol/infrastructure/ansible/roles/to_api/tasks/queue_updates.yml Line 20 in df92555 url: "{{ to_api_base_url }}/api/1.2/cdns"
POST	api/1.2/cdns/{{name}}/queue_update	trafficcontrol/infrastructure/ansible/roles/to_api/tasks/queue_updates.yml Line 32 in df92555 url: "{{ to_api_base_url }}/api/1.2/cdns/{{ cdns_details.json.response | selectattr('name','equalto',to_api_target_cdn) | map(attribute='id') | list | first }}/queue_update"
GET	api/1.2/servers/hostname/{{name}}/details	trafficcontrol/infrastructure/ansible/roles/to_api/tasks/set_server_status.yml Line 20 in df92555 url: "{{ to_api_base_url }}/api/1.2/servers/hostname/{{ to_api_target_host.split('.')[0] }}/details"
PUT	api/1.2/servers/{{id}}/status	trafficcontrol/infrastructure/ansible/roles/to_api/tasks/set_server_status.yml Line 43 in df92555 url: "{{ to_api_base_url }}/api/1.2/servers/{{ server_details.json.response.id }}/status"
GET	api/1.2/cdns/{{name}}/snapshot/new	trafficcontrol/infrastructure/ansible/roles/to_api/tasks/snapshot.yml Line 67 in df92555 url: "{{ to_api_base_url }}/api/1.2/cdns/{{ to_api_target_cdn }}/snapshot/new"
GET	api/1.3/servers/checks	trafficcontrol/infrastructure/ansible/roles/traffic_portal/defaults/main.yml Line 85 in df92555 should include an entry for each of your extensions or you can check GET api/1.3/servers/checks
*	1.3	trafficcontrol/infrastructure/ansible/sample.lab/ansible/vars.yml Line 28 in df92555 to_api_version: "1.3"

New behavior:

Those lines of code should reference API v3, reference API v4, or be removed.

See https://traffic-control-cdn.readthedocs.io/en/latest/api/migrating-from-v1.html#updating-endpoints-manually for which Traffic Ops API v3 endpoint to update each API v1 endpoint to.

[jhg03a]

There are a whole lot more 1.3 API uses in the dataset loader than are noted above.

[ragen14]

Picking this up