Added ND backup schedule module to manage backup schedule jobs on ND 4.1 and later (DCNE-496) #162
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ule jobs on ND 4.1 and later
sajagana
requested review from
akinross,
anvitha-jain,
gmicol,
lhercot,
samiib and
shrsr
as code owners
shrsr
requested changes
Jul 30, 2025
| aliases: [ scheduler_start_time, start_time, time ] | ||
| backup_type: | ||
| description: | ||
| - The O(backup_type=config_only) option creates a snapshot that specifically captures the configuration settings of the Nexus Dashboard. |
There was a problem hiding this comment.
Can we add a description for backup_type?
- This parameter specifies the kind of snapshot created for the Nexus Dashboard.
| path = "/api/v1/infra/backups/schedules" | ||
| schedules = nd.query_obj(path) | ||
| if name: | ||
| for schedule in schedules.get("schedules"): |
There was a problem hiding this comment.
I think it would be good to use a generic function here (which I'm using in my module)
nd.existing = nd.previous = nd.get_object_by_nested_key_value(path, nested_key_path="name", value=name, data_key="schedules")
if nd.existing:
path = "{0}/{1}".format(path, name)
This should be added in nd.py of module_utils:
def get_object_by_nested_key_value(self, path, nested_key_path, value, data_key=None):
response_data = self.request(path, method="GET")
if not response_data:
return None
object_list = []
if isinstance(response_data, list):
object_list = response_data
elif data_key and data_key in response_data:
object_list = response_data.get(data_key)
else:
return None
keys = nested_key_path.split('.')
for obj in object_list:
current_level = obj
for key in keys:
if isinstance(current_level, dict):
current_level = current_level.get(key)
else:
current_level = None
break
if current_level == value:
return obj
return None
There was a problem hiding this comment.
Added the function to nd.py and changed the function return value based on the input value.
| nd.existing = schedules | ||
|
|
||
| if state == "present": | ||
| if nd.existing and nd.existing.get("name") == name: |
There was a problem hiding this comment.
Can we simplify this as shown below if applicable?
payload = {
"encryptionKey": encryption_key,
"name": name,
"type": backup_type,
"frequency": frequency,
"remoteLocation": remote_location,
"startTime": start_date_time,
}
if nd.existing and nd.existing.get("name") == name:
payload["frequency"] = frequency or nd.existing.get("frequency")
payload["remoteLocation"] = remote_location or nd.existing.get("remoteLocation")
payload["startTime"] = start_date_time or nd.existing.get("startTime")
shrsr
requested changes
Jul 30, 2025
| path = "{0}/{1}".format(path, name) | ||
| break | ||
|
|
||
| schedules = nd.get_object_by_nested_key_value(path, "name", name, data_key="schedules") |
There was a problem hiding this comment.
This only returns the schedule with the name
There was a problem hiding this comment.
if not value and response_data and data_key and data_key in response_data:
return response_data.get(data_key)
elif not response_data:
return None
I changed the suggested code to support query one and query all objects based on the input value. Should I revert this change?
There was a problem hiding this comment.
Yes, I think it's best to let the function do what its name suggests
shrsr
requested changes
Jul 31, 2025
| path = "{0}/{1}".format(path, name) | ||
| break | ||
|
|
||
| schedules = nd.get_object_by_nested_key_value(path, "name", name, data_key="schedules") |
There was a problem hiding this comment.
Yes, I think it's best to let the function do what its name suggests
samiib
requested changes
Jul 31, 2025
| type: str | ||
| encryption_key: | ||
| description: | ||
| - The encryption_key for a backup file. |
There was a problem hiding this comment.
Suggested change
| - The encryption_key for a backup file. | |
| - The encryption key for a backup file. |
| --- | ||
| module: nd_backup_schedule | ||
| version_added: "0.5.0" | ||
| short_description: Manages backup schedule on Cisco Nexus Dashboard. |
There was a problem hiding this comment.
Suggested change
| short_description: Manages backup schedule on Cisco Nexus Dashboard. | |
| short_description: Manages backup schedules on Cisco Nexus Dashboard. |
| version_added: "0.5.0" | ||
| short_description: Manages backup schedule on Cisco Nexus Dashboard. | ||
| description: | ||
| - Manage backup schedule on Cisco Nexus Dashboard. |
There was a problem hiding this comment.
Suggested change
| - Manage backup schedule on Cisco Nexus Dashboard. | |
| - Manage backup schedules on Cisco Nexus Dashboard. |
… return the specific object
anvitha-jain
requested changes
Aug 6, 2025
| - cm_rm_backup_schedule.previous.name == "backupschedule1" | ||
| - cm_rm_backup_schedule.previous.remoteLocation == "test" | ||
| - cm_rm_backup_schedule.previous.startTime == "2025-01-02T15:04:05Z" | ||
| - cm_rm_backup_schedule.previous.type == "configOnly" |
There was a problem hiding this comment.
can we not add a test case with backup_type parameter?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.